-
Notifications
You must be signed in to change notification settings - Fork 122
/
InstrumentDefinitionParser.cpp
2575 lines (2200 loc) · 105 KB
/
InstrumentDefinitionParser.cpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#include "MantidGeometry/Instrument/InstrumentDefinitionParser.h"
#include "MantidGeometry/Instrument/Detector.h"
#include "MantidGeometry/Instrument/ObjCompAssembly.h"
#include "MantidGeometry/Instrument/ReferenceFrame.h"
#include "MantidGeometry/Instrument/RectangularDetector.h"
#include "MantidGeometry/Instrument/XMLlogfile.h"
#include "MantidGeometry/Objects/ShapeFactory.h"
#include "MantidGeometry/Rendering/vtkGeometryCacheReader.h"
#include "MantidGeometry/Rendering/vtkGeometryCacheWriter.h"
#include "MantidKernel/ConfigService.h"
#include "MantidKernel/ProgressBase.h"
#include "MantidKernel/UnitFactory.h"
#include <fstream>
#include <Poco/DOM/Document.h>
#include <Poco/DOM/DOMParser.h>
#include <Poco/DOM/DOMWriter.h>
#include <Poco/DOM/Element.h>
#include <Poco/DOM/NodeFilter.h>
#include <Poco/DOM/NodeIterator.h>
#include <Poco/DOM/NodeList.h>
#include <Poco/SAX/AttributesImpl.h>
#include <boost/make_shared.hpp>
#include <boost/assign/list_of.hpp>
using namespace Mantid;
using namespace Mantid::Kernel;
using Poco::XML::DOMParser;
using Poco::XML::Document;
using Poco::XML::Element;
using Poco::XML::Node;
using Poco::XML::NodeList;
using Poco::XML::NodeIterator;
using Poco::XML::NodeFilter;
namespace Mantid
{
namespace Geometry
{
// Initialize the logger
Kernel::Logger& InstrumentDefinitionParser::g_log = Kernel::Logger::get("InstrumentDefinitionParser");
//----------------------------------------------------------------------------------------------
/** Constructor
*/
InstrumentDefinitionParser::InstrumentDefinitionParser()
: m_xmlFile(boost::make_shared<NullIDFObject>()), m_cacheFile(boost::make_shared<NullIDFObject>()), pDoc(NULL), pRootElem(NULL),
hasParameterElement_beenSet(false),
m_haveDefaultFacing(false), m_deltaOffsets(false),
m_angleConvertConst(1.0),m_indirectPositions(false),
m_cachingOption(NoneApplied)
{
}
//----------------------------------------------------------------------------------------------
/** Destructor
*/
InstrumentDefinitionParser::~InstrumentDefinitionParser()
{
}
//----------------------------------------------------------------------------------------------
/** Initialize the XML parser based on an IDF xml file path.
*
* Note that this convenience initialize method actually translates the inputs into the other initialize method.
*
* @param filename :: IDF .xml path (full). This is needed mostly to find the instrument geometry cache.
* @param instName :: name of the instrument
* @param xmlText :: XML contents of IDF
*/
void InstrumentDefinitionParser::initialize(const std::string & filename, const std::string & instName, const std::string & xmlText)
{
IDFObject_const_sptr xmlFile = boost::make_shared<const IDFObject>(filename);
// Use the filename to construct the cachefile name so that there is a 1:1 map between a definition file & cache
std::string idfExt = xmlFile->getExtension();
std::string vtpFilename = filename;
static const char * vtpExt = ".vtp";
if(idfExt.empty())
{
vtpFilename += vtpExt;
}
else
{
boost::replace_last(vtpFilename, idfExt, vtpExt);
}
IDFObject_const_sptr vtpFile = boost::make_shared<const IDFObject>(vtpFilename);
this->initialize(xmlFile, vtpFile, instName, xmlText);
}
//----------------------------------------------------------------------------------------------
/** Initialize the XML parser based on an IDF xml and cached vtp file objects.
*
* @param xmlFile :: The xml file, here wrapped in a IDFObject
* @param expectedCacheFile :: Expected vtp cache file
* @param instName :: Instrument name
* @param xmlText :: XML contents of IDF
*/
void InstrumentDefinitionParser::initialize(const IDFObject_const_sptr xmlFile, const IDFObject_const_sptr expectedCacheFile, const std::string & instName, const std::string & xmlText)
{
// Handle the parameters
const std::string filename = xmlFile->getFileFullPathStr();
m_instName = instName;
m_xmlFile = xmlFile;
m_cacheFile = expectedCacheFile;
// Set up the DOM parser and parse xml file
DOMParser pParser;
try
{
pDoc = pParser.parseString(xmlText);
}
catch(Poco::Exception& exc)
{
throw Kernel::Exception::FileError(exc.displayText() + ". Unable to parse XML", filename);
}
catch(...)
{
throw Kernel::Exception::FileError("Unable to parse XML" , filename);
}
// Get pointer to root element
pRootElem = pDoc->documentElement();
if ( !pRootElem->hasChildNodes() )
{
g_log.error("XML file: " + filename + "contains no root element.");
throw Kernel::Exception::InstrumentDefinitionError("No root element in XML instrument file", filename);
}
// Create our new instrument
// We don't want the instrument name taken out of the XML file itself, it should come from the filename (or the property)
m_instrument = boost::make_shared<Instrument>(m_instName);
// Save the XML file path and contents
m_instrument->setFilename(filename);
m_instrument->setXmlText(xmlText);
}
//----------------------------------------------------------------------------------------------
/**
* Handle used in the singleton constructor for instrument file should append the value
* of the last-modified tag inside the file to determine if it is already in memory so that
* changes to the instrument file will cause file to be reloaded.
*
* @return a mangled name combining the filename and the "last-modified" attribute of the XML contents
* */
std::string InstrumentDefinitionParser::getMangledName()
{
// Use the file in preference if possible.
if(this->m_xmlFile->exists())
{
return m_xmlFile->getMangledName();
}
else if ( ! pDoc.isNull() )
{
std::string lastModified = pRootElem->getAttribute("last-modified");
if (lastModified.empty())
{
g_log.warning() << "The IDF that you are using doesn't contain a 'last-modified' field. ";
g_log.warning() << "You may not get the correct definition file loaded." << std::endl ;
}
return m_instName + lastModified;
}
else
{
throw std::runtime_error("Call InstrumentDefinitionParser::initialize() before getMangledName.");
}
}
//----------------------------------------------------------------------------------------------
/** Fully parse the IDF XML contents and returns the instrument thus created
*
* @param prog :: Optional Progress reporter object. If NULL, no progress reporting.
* @return the instrument that was created
*/
Instrument_sptr InstrumentDefinitionParser::parseXML(Kernel::ProgressBase * prog)
{
if (!pDoc)
throw std::runtime_error("Call InstrumentDefinitionParser::initialize() before parseXML.");
setValidityRange(pRootElem);
readDefaults(pRootElem->getChildElement("defaults"));
// create maps: isTypeAssembly and mapTypeNameToShape
Geometry::ShapeFactory shapeCreator;
const std::string filename = m_xmlFile->getFileFullPathStr();
Poco::AutoPtr<NodeList> pNL_type = pRootElem->getElementsByTagName("type");
if ( pNL_type->length() == 0 )
{
g_log.error("XML file: " + filename + "contains no type elements.");
throw Kernel::Exception::InstrumentDefinitionError("No type elements in XML instrument file", filename);
}
// Collect some information about types for later use including:
// * populate directory getTypeElement
// * populate directory isTypeAssemply
// * create shapes for all none assemply components and store in mapTyepNameToShape
// * If 'Outline' attribute set for assemply add attribute object_created=no to tell
// create shape for such assemply also later
unsigned long numberTypes = pNL_type->length();
for (unsigned long iType = 0; iType < numberTypes; iType++)
{
Element* pTypeElem = static_cast<Element*>(pNL_type->item(iType));
std::string typeName = pTypeElem->getAttribute("name");
// check if contain <combine-components-into-one-shape>. If this then such
// types are adjusted after this loop has completed
Poco::AutoPtr<NodeList> pNL_type_combine_into_one_shape = pTypeElem->getElementsByTagName("combine-components-into-one-shape");
if ( pNL_type_combine_into_one_shape->length() > 0 )
{
continue;
}
// Each type in the IDF must be uniquely named, hence return error if type
// has already been defined
if ( getTypeElement.find(typeName) != getTypeElement.end() )
{
g_log.error("XML file: " + filename + "contains more than one type element named " + typeName);
throw Kernel::Exception::InstrumentDefinitionError("XML instrument file contains more than one type element named " + typeName, filename);
}
getTypeElement[typeName] = pTypeElem;
// identify for now a type to be an assemble by it containing elements
// with tag name 'component'
Poco::AutoPtr<NodeList> pNL_local = pTypeElem->getElementsByTagName("component");
if (pNL_local->length() == 0)
{
isTypeAssembly[typeName] = false;
// for now try to create a geometry shape associated with every type
// that does not contain any component elements
mapTypeNameToShape[typeName] = shapeCreator.createShape(pTypeElem);
mapTypeNameToShape[typeName]->setName(static_cast<int>(iType));
}
else
{
isTypeAssembly[typeName] = true;
if (pTypeElem->hasAttribute("outline"))
{
pTypeElem->setAttribute("object_created","no");
}
}
}
// Deal with adjusting types containing <combine-components-into-one-shape>
for (unsigned long iType = 0; iType < numberTypes; iType++)
{
Element* pTypeElem = static_cast<Element*>(pNL_type->item(iType));
std::string typeName = pTypeElem->getAttribute("name");
// In this loop only interested in types containing <combine-components-into-one-shape>
Poco::AutoPtr<NodeList> pNL_type_combine_into_one_shape = pTypeElem->getElementsByTagName("combine-components-into-one-shape");
const unsigned long nelements = pNL_type_combine_into_one_shape->length();
if ( nelements == 0 )
continue;
// Each type in the IDF must be uniquely named, hence return error if type
// has already been defined
if ( getTypeElement.find(typeName) != getTypeElement.end() )
{
g_log.error("XML file: " + filename + "contains more than one type element named " + typeName);
throw Kernel::Exception::InstrumentDefinitionError("XML instrument file contains more than one type element named " + typeName, filename);
}
getTypeElement[typeName] = pTypeElem;
InstrumentDefinitionParser helper;
helper.adjust(pTypeElem, isTypeAssembly, getTypeElement);
isTypeAssembly[typeName] = false;
mapTypeNameToShape[typeName] = shapeCreator.createShape(pTypeElem);
mapTypeNameToShape[typeName]->setName(static_cast<int>(iType));
}
// create hasParameterElement
Poco::AutoPtr<NodeList> pNL_parameter = pRootElem->getElementsByTagName("parameter");
unsigned long numParameter = pNL_parameter->length();
hasParameterElement.reserve(numParameter);
// It turns out that looping over all nodes and checking if their nodeName is equal
// to "parameter" is much quicker than looping over the pNL_parameter NodeList.
Poco::XML::NodeIterator it(pRootElem, Poco::XML::NodeFilter::SHOW_ELEMENT);
Poco::XML::Node* pNode = it.nextNode();
while(pNode)
{
if (pNode->nodeName() == "parameter")
{
Element* pParameterElem = static_cast<Element*>(pNode);
hasParameterElement.push_back( static_cast<Element*>(pParameterElem->parentNode()) );
}
pNode = it.nextNode();
}
hasParameterElement_beenSet = true;
// See if any parameters set at instrument level
setLogfile(m_instrument.get(), pRootElem, m_instrument->getLogfileCache());
//
// do analysis for each top level compoment element
//
Poco::AutoPtr<NodeList> pNL_comp = pRootElem->childNodes(); // here get all child nodes
unsigned long pNL_comp_length = pNL_comp->length();
if (prog) prog->resetNumSteps(pNL_comp_length, 0.0, 1.0);
for (unsigned long i = 0; i < pNL_comp_length; i++)
{
if(prog) prog->report("Loading instrument Definition");
// we are only interest in the top level component elements hence
// the reason for the if statement below
if ( (pNL_comp->item(i))->nodeType() == Node::ELEMENT_NODE &&
((pNL_comp->item(i))->nodeName()).compare("component") == 0 )
{
const Element* pElem = static_cast<Element*>(pNL_comp->item(i));
IdList idList; // structure to possibly be populated with detector IDs
// Get all <location> and <locations> elements contained in component element
// just for the purpose of a IDF syntax check
Poco::AutoPtr<NodeList> pNL_location = pElem->getElementsByTagName("location");
Poco::AutoPtr<NodeList> pNL_locations = pElem->getElementsByTagName("locations");
// do a IDF syntax check
if (pNL_location->length() == 0 && pNL_locations->length() == 0)
{
g_log.error(std::string("A component element must contain at least one <location> or <locations> element") +
" even if it is just an empty location element of the form <location />");
throw Kernel::Exception::InstrumentDefinitionError(
std::string("A component element must contain at least one <location> or <locations> element") +
" even if it is just an empty location element of the form <location />", filename);
}
// Loop through all <location> and <locations> elements of this component by looping
// all the child nodes and then see if any of these nodes are either <location> or
// <locations> elements. Done this way order these locations are processed is the
// order they are listed in the IDF. The latter needed to get detector IDs assigned
// as expected
Poco::AutoPtr<NodeList> pNL_childs = pElem->childNodes(); // here get all child nodes
unsigned long pNL_childs_length = pNL_childs->length();
for (unsigned long iLoc = 0; iLoc < pNL_childs_length; iLoc++)
{
if ( (pNL_childs->item(iLoc))->nodeType() == Node::ELEMENT_NODE &&
( ((pNL_childs->item(iLoc))->nodeName()).compare("location") == 0 || ((pNL_childs->item(iLoc))->nodeName()).compare("locations") == 0 )
)
{
// if a <location> element
if ( ((pNL_childs->item(iLoc))->nodeName()).compare("location") == 0 )
{
const Element* pLocElem = static_cast<Element*>(pNL_childs->item(iLoc));
// process differently depending on whether component is and assembly or leaf
if ( isAssembly(pElem->getAttribute("type")) )
{
appendAssembly(m_instrument.get(), pLocElem, pElem, idList);
}
else
{
appendLeaf(m_instrument.get(), pLocElem, pElem, idList);
}
}
// if a <locations> element
if ( ((pNL_childs->item(iLoc))->nodeName()).compare("locations") == 0 )
{
const Element* pLocElems = static_cast<Element*>(pNL_childs->item(iLoc));
// append <locations> elements in <locations>
appendLocations(m_instrument.get(), pLocElems, pElem, idList);
}
}
} // finished looping over all childs of this component
// A check
if (idList.counted != static_cast<int>(idList.vec.size()) )
{
std::stringstream ss1, ss2;
ss1 << idList.vec.size(); ss2 << idList.counted;
if( !pElem->hasAttribute("idlist") ) {
g_log.error("No detector ID list found for detectors of type "
+ pElem->getAttribute("type"));
}
else if( idList.vec.size() == 0) {
g_log.error("No detector IDs found for detectors in list "
+ pElem->getAttribute("idlist") +
"for detectors of type"
+ pElem->getAttribute("type"));
} else {
g_log.error("The number of detector IDs listed in idlist named "
+ pElem->getAttribute("idlist") +
" is larger than the number of detectors listed in type = "
+ pElem->getAttribute("type"));
}
throw Kernel::Exception::InstrumentDefinitionError(
"Number of IDs listed in idlist (=" + ss1.str() + ") is larger than the number of detectors listed in type = "
+ pElem->getAttribute("type") + " (=" + ss2.str() + ").", filename);
}
idList.reset();
}
}
// Don't need this anymore (if it was even used) so empty it out to save memory
m_tempPosHolder.clear();
// Read in or create the geometry cache file
m_cachingOption = setupGeometryCache();
// Add/overwrite any instrument params with values specified in <component-link> XML elements
setComponentLinks(m_instrument, pRootElem);
if ( m_indirectPositions ) createNeutronicInstrument();
// And give back what we created
return m_instrument;
}
//-----------------------------------------------------------------------------------------------------------------------
/** Assumes second argument is a XML location element and its parent is a component element
* which is assigned to be an assembly. This method appends the parent component element of
* the location element to the CompAssembly passed as the 1st arg. Note this method may call
* itself, i.e. it may act recursively.
*
* @param parent :: CompAssembly to append new component to
* @param pLocElems :: Poco::XML element that points to a locations element in an instrument description XML file, which optionally may be detached (meaning it is not required to be part of the DOM tree of the IDF)
* @param pCompElem :: The Poco::XML \<component\> element that contains the \<locations\> element
* @param idList :: The current IDList
*/
void InstrumentDefinitionParser::appendLocations(Geometry::ICompAssembly* parent, const Poco::XML::Element*pLocElems, const Poco::XML::Element* pCompElem, IdList& idList)
{
// create detached <location> elements from <locations> element
const std::string xmlLocation = convertLocationsElement(pLocElems);
// parse converted <locations> output
DOMParser pLocationsParser;
Poco::AutoPtr<Document> pLocationsDoc;
try
{
pLocationsDoc = pLocationsParser.parseString(xmlLocation);
}
catch(...)
{
throw Kernel::Exception::InstrumentDefinitionError("Unable to parse XML string", xmlLocation);
}
// Get pointer to root element
const Element* pRootLocationsElem = pLocationsDoc->documentElement();
if ( !pRootLocationsElem->hasChildNodes() )
{
throw Kernel::Exception::InstrumentDefinitionError("No root element in XML string", xmlLocation);
}
Poco::AutoPtr<NodeList> pNL_locInLocs = pRootLocationsElem->getElementsByTagName("location");
unsigned long pNL_locInLocs_length = pNL_locInLocs->length();
for (unsigned long iInLocs = 0; iInLocs < pNL_locInLocs_length; iInLocs++)
{
const Element* pLocInLocsElem = static_cast<Element*>(pNL_locInLocs->item(iInLocs));
if ( isAssembly(pCompElem->getAttribute("type")) )
{
appendAssembly(parent, pLocInLocsElem, pCompElem, idList);
}
else
{
appendLeaf(parent, pLocInLocsElem, pCompElem, idList);
}
}
}
//-----------------------------------------------------------------------------------------------------------------------
/** Save DOM tree to xml file. This method was initially added for testing purpose
* but may be useful for other purposes. During the parsing of the DOM tree
* in parseXML() the tree may be modified, e.g. if <combine-components-into-one-shape>
* is used.
*
* @param outFilename :: Output filename
*/
void InstrumentDefinitionParser::saveDOM_Tree(std::string& outFilename)
{
Poco::XML::DOMWriter writer;
writer.setNewLine("\n");
writer.setOptions(Poco::XML::XMLWriter::PRETTY_PRINT);
std::ofstream outFile(outFilename.c_str());
writer.writeNode(outFile, pDoc);
outFile.close();
}
//-----------------------------------------------------------------------------------------------------------------------
/** Set location (position) of comp as specified in XML location element.
*
* @param comp :: To set position/location off
* @param pElem :: Poco::XML element that points a \<location\> element, which optionally may be detached (meaning it is not required to be part of the DOM tree of the IDF)
* @param angleConvertConst :: constant for converting deg to rad
* @param deltaOffsets :: radial position offsets
*
* @throw logic_error Thrown if second argument is not a pointer to a 'location' XML element
*/
void InstrumentDefinitionParser::setLocation(Geometry::IComponent* comp, const Poco::XML::Element* pElem,
const double angleConvertConst, const bool deltaOffsets)
{
comp->setPos(getRelativeTranslation(comp, pElem, angleConvertConst, deltaOffsets));
// Rotate coordinate system of this component
if ( pElem->hasAttribute("rot") )
{
double rotAngle = angleConvertConst*atof( (pElem->getAttribute("rot")).c_str() ); // assumed to be in degrees
double axis_x = 0.0;
double axis_y = 0.0;
double axis_z = 1.0;
if ( pElem->hasAttribute("axis-x") )
axis_x = atof( (pElem->getAttribute("axis-x")).c_str() );
if ( pElem->hasAttribute("axis-y") )
axis_y = atof( (pElem->getAttribute("axis-y")).c_str() );
if ( pElem->hasAttribute("axis-z") )
axis_z = atof( (pElem->getAttribute("axis-z")).c_str() );
comp->rotate(Kernel::Quat(rotAngle, Kernel::V3D(axis_x,axis_y,axis_z)));
}
// Check if sub-elements <trans> or <rot> of present - for now ignore these if m_deltaOffset = true
Element* pRecursive = NULL;
Element* tElem = pElem->getChildElement("trans");
Element* rElem = pElem->getChildElement("rot");
bool stillTransElement = true;
bool firstRound = true; // during first round below pRecursive has not been set up front
while ( stillTransElement )
{
// figure out if child element is <trans> or <rot> or none of these
if (firstRound)
{
firstRound = false;
}
else
{
tElem = pRecursive->getChildElement("trans");
rElem = pRecursive->getChildElement("rot");
}
if (tElem && rElem)
{
// if both a <trans> and <rot> child element present. Ignore <rot> element
rElem = NULL;
}
if (!tElem && !rElem)
{
stillTransElement = false;
}
Kernel::V3D posTrans;
if (tElem)
{
posTrans = getRelativeTranslation(comp, tElem, angleConvertConst, deltaOffsets);
// to get the change in translation relative to current rotation of comp
Geometry::CompAssembly compToGetRot;
Geometry::CompAssembly compRot;
compRot.setRot(comp->getRotation());
compToGetRot.setParent(&compRot);
compToGetRot.setPos(posTrans);
// Apply translation
comp->translate(compToGetRot.getPos());
// for recursive action
pRecursive = tElem;
} // end translation
if (rElem)
{
double rotAngle = angleConvertConst*atof( (rElem->getAttribute("val")).c_str() ); // assumed to be in degrees
double axis_x = 0.0;
double axis_y = 0.0;
double axis_z = 1.0;
if ( rElem->hasAttribute("axis-x") )
axis_x = atof( (rElem->getAttribute("axis-x")).c_str() );
if ( rElem->hasAttribute("axis-y") )
axis_y = atof( (rElem->getAttribute("axis-y")).c_str() );
if ( rElem->hasAttribute("axis-z") )
axis_z = atof( (rElem->getAttribute("axis-z")).c_str() );
comp->rotate(Kernel::Quat(rotAngle, Kernel::V3D(axis_x,axis_y,axis_z)));
// for recursive action
pRecursive = rElem;
}
} // end while
}
//-----------------------------------------------------------------------------------------------------------------------
/** Calculate the position of comp relative to its parent from info provided by \<location\> element.
*
* @param comp :: To set position/location off
* @param pElem :: Poco::XML element that points a \<location\> element, which optionally may be detached (meaning it is not required to be part of the DOM tree of the IDF)
* @param angleConvertConst :: constant for converting deg to rad
* @param deltaOffsets :: radial position offsets
*
* @return Thrown if second argument is not a pointer to a 'location' XML element
*/
Kernel::V3D InstrumentDefinitionParser::getRelativeTranslation(const Geometry::IComponent* comp, const Poco::XML::Element* pElem,
const double angleConvertConst, const bool deltaOffsets)
{
Kernel::V3D retVal; // position relative to parent
// Polar coordinates can be labelled as (r,t,p) or (R,theta,phi)
if ( pElem->hasAttribute("r") || pElem->hasAttribute("t") || pElem->hasAttribute("p") ||
pElem->hasAttribute("R") || pElem->hasAttribute("theta") || pElem->hasAttribute("phi") )
{
double R=0.0, theta=0.0, phi=0.0;
if ( pElem->hasAttribute("r") ) R = atof((pElem->getAttribute("r")).c_str());
if ( pElem->hasAttribute("t") ) theta = angleConvertConst*atof((pElem->getAttribute("t")).c_str());
if ( pElem->hasAttribute("p") ) phi = angleConvertConst*atof((pElem->getAttribute("p")).c_str());
if ( pElem->hasAttribute("R") ) R = atof((pElem->getAttribute("R")).c_str());
if ( pElem->hasAttribute("theta") ) theta = angleConvertConst*atof((pElem->getAttribute("theta")).c_str());
if ( pElem->hasAttribute("phi") ) phi = angleConvertConst*atof((pElem->getAttribute("phi")).c_str());
if ( deltaOffsets )
{
// In this case, locations given are radial offsets to the (radial) position of the parent,
// so need to do some extra calculation before they're stored internally as x,y,z offsets.
// Temporary vector to hold the parent's absolute position (will be 0,0,0 if no parent)
Kernel::V3D parentPos;
// Get the parent's absolute position (if the component has a parent)
if ( comp->getParent() )
{
std::map<const Geometry::IComponent*, SphVec>::iterator it;
it = m_tempPosHolder.find(comp);
SphVec parent;
if ( it == m_tempPosHolder.end() )
parent = m_tempPosHolder[comp->getParent().get()];
else
parent = it->second;
// Add to the current component to get its absolute position
R += parent.r;
theta += parent.theta;
phi += parent.phi;
// Set the temporary V3D with the parent's absolute position
parentPos.spherical(parent.r,parent.theta,parent.phi);
}
// Create a temporary vector that holds the absolute r,theta,phi position
// Needed to make things work in situation when a parent object has a phi value but a theta of zero
SphVec tmp(R,theta,phi);
// Add it to the map with the pointer to the Component object as key
m_tempPosHolder[comp] = tmp;
// Create a V3D and set its position to be the child's absolute position
Kernel::V3D absPos;
absPos.spherical(R,theta,phi);
// Subtract the two V3D's to get what we want (child's relative position in x,y,z)
retVal = absPos - parentPos;
}
else
{
// In this case, the value given represents a vector from the parent to the child
retVal.spherical(R,theta,phi);
}
}
else
{
double x=0.0, y=0.0, z=0.0;
if ( pElem->hasAttribute("x") ) x = atof((pElem->getAttribute("x")).c_str());
if ( pElem->hasAttribute("y") ) y = atof((pElem->getAttribute("y")).c_str());
if ( pElem->hasAttribute("z") ) z = atof((pElem->getAttribute("z")).c_str());
retVal(x,y,z);
}
return retVal;
}
//-----------------------------------------------------------------------------------------------------------------------
/** Get parent \<component\> element of \<location\> element.
*
* @param pLocElem :: Poco::XML element that points a location element in the XML doc
* @return Parent XML element to a location XML element
*
* @throw logic_error Thrown if argument is not a child of component element
*/
Poco::XML::Element* InstrumentDefinitionParser::getParentComponent(const Poco::XML::Element* pLocElem)
{
if ( (pLocElem->tagName()).compare("location") && (pLocElem->tagName()).compare("locations") )
{
std::string tagname = pLocElem->tagName();
g_log.error("Argument to function getParentComponent must be a pointer to an XML element with tag name location or locations.");
throw std::logic_error( std::string("Argument to function getParentComponent must be a pointer to an XML element")
+ "with tag name location or locations." + " The tag name is " + tagname);
}
// The location element is required to be a child of a component element. Get this component element
Node* pCompNode = pLocElem->parentNode();
Element* pCompElem;
if (pCompNode->nodeType() == 1)
{
pCompElem = static_cast<Element*>(pCompNode);
if ( (pCompElem->tagName()).compare("component") )
{
g_log.error("Argument to function getParentComponent must be a XML element sitting inside a component element.");
throw std::logic_error( "Argument to function getParentComponent must be a XML element sitting inside a component element." );
}
}
else
{
g_log.error("Argument to function getParentComponent must be a XML element whos parent is an element.");
throw std::logic_error( "Argument to function getParentComponent must be a XML element whos parent is an element." );
}
return pCompElem;
}
//-----------------------------------------------------------------------------------------------------------------------
/** Get name of a location element. It will return the value of the attribute 'name', or the
* parent's name attribute, or the parent's type, if all else fails.
*
* @param pElem :: Poco::XML element that points to a \<location\> element, which optionally may be detached (meaning it is not required to be part of the DOM tree of the IDF)
* @param pCompElem :: The Poco::XML \<component\> element that contain the location element, which may optionally be detached from the DOM tree also
* @return name of location element
*/
std::string InstrumentDefinitionParser::getNameOfLocationElement(const Poco::XML::Element* pElem, const Poco::XML::Element* pCompElem)
{
std::string retVal;
if ( pElem->hasAttribute("name") )
retVal = pElem->getAttribute("name");
else if ( pCompElem->hasAttribute("name") )
{
retVal = pCompElem->getAttribute("name");
}
else
{
retVal = pCompElem->getAttribute("type");
}
return retVal;
}
//------------------------------------------------------------------------------------------------------------------------------
/** Checks the validity range in the IDF and adds it to the instrument object
* @param pRootElem A pointer to the root element of the instrument definition
*/
void InstrumentDefinitionParser::setValidityRange(const Poco::XML::Element* pRootElem)
{
const std::string filename = m_xmlFile->getFileFullPathStr();
// check if IDF has valid-from and valid-to tags defined
if ( !pRootElem->hasAttribute("valid-from") )
{
throw Kernel::Exception::InstrumentDefinitionError("<instrument> element must contain a valid-from tag", filename);
}
else
{
try
{
DateAndTime d(pRootElem->getAttribute("valid-from"));
m_instrument->setValidFromDate(d);
}
catch(...)
{
throw Kernel::Exception::InstrumentDefinitionError("The valid-from <instrument> tag must be a ISO8601 string", filename);
}
}
if ( !pRootElem->hasAttribute("valid-to") )
{
DateAndTime d = DateAndTime::getCurrentTime();
m_instrument->setValidToDate(d);
// Ticket #2335: no required valid-to date.
//throw Kernel::Exception::InstrumentDefinitionError("<instrument> element must contain a valid-to tag", filename);
}
else
{
try
{
DateAndTime d(pRootElem->getAttribute("valid-to"));
m_instrument->setValidToDate(d);
}
catch(...)
{
throw Kernel::Exception::InstrumentDefinitionError("The valid-to <instrument> tag must be a ISO8601 string", filename);
}
}
}
PointingAlong axisNameToAxisType(std::string& input)
{
PointingAlong direction;
if(input.compare("x") == 0)
{
direction = X;
}
else if(input.compare("y") == 0)
{
direction = Y;
}
else
{
direction = Z;
}
return direction;
}
//-----------------------------------------------------------------------------------------------------------------------
/** Reads the contents of the \<defaults\> element to set member variables,
* requires m_instrument to be already set
* @param defaults :: points to the data read from the \<defaults\> element, can be null.
*/
void InstrumentDefinitionParser::readDefaults(Poco::XML::Element* defaults)
{
// Return without complaint, if there are no defaults
if(!defaults) return;
// Check whether spherical coordinates should be treated as offsets to parents position
std::string offsets;
Element* offsetElement = defaults->getChildElement("offsets");
if (offsetElement) offsets = offsetElement->getAttribute("spherical");
if ( offsets == "delta" ) m_deltaOffsets = true;
// Check whether default facing is set
Element* defaultFacingElement = defaults->getChildElement("components-are-facing");
if (defaultFacingElement)
{
m_haveDefaultFacing = true;
m_defaultFacing = parseFacingElementToV3D(defaultFacingElement);
}
// the default view is used by the instrument viewer to decide the angle to display the instrument from on start up
Element* defaultView = defaults->getChildElement("default-view");
if (defaultView)
{
m_instrument->setDefaultViewAxis(defaultView->getAttribute("axis-view"));
if ( defaultView->hasAttribute("view") )
{
m_instrument->setDefaultView( defaultView->getAttribute("view") );
}
}
// check if angle=radian has been set
Element* angleUnit = defaults->getChildElement("angle");
if (angleUnit)
{
if (angleUnit->getAttribute("unit") == "radian")
{
m_angleConvertConst = 180.0/M_PI;
std::map<std::string, std::string>& units = m_instrument->getLogfileUnit();
units["angle"] = "radian";
}
}
// Check if the IDF specifies that this is an indirect geometry instrument that includes
// both physical and 'neutronic' postions.
// Any neutronic position tags will be ignored if this tag is missing
if ( defaults->getChildElement("indirect-neutronic-positions") )
m_indirectPositions = true;
/*
Try to extract the reference frame information.
*/
//Get the target xml element.
Element* referenceFrameElement = defaults->getChildElement("reference-frame");
//Extract if available
if(referenceFrameElement)
{
using Poco::XML::XMLString;
//Get raw xml values
Element* upElement = referenceFrameElement->getChildElement("pointing-up");
Element* alongElement = referenceFrameElement->getChildElement("along-beam");
Element* handednessElement = referenceFrameElement->getChildElement("handedness");
Element* originElement = referenceFrameElement->getChildElement("origin");
//Defaults
XMLString s_alongBeam("z");
XMLString s_pointingUp("y");
XMLString s_handedness("right");
XMLString s_origin("");
//Make extractions from sub elements where possible.
if(alongElement)
{
s_alongBeam = alongElement->getAttribute("axis");
}
if(upElement)
{
s_pointingUp = upElement->getAttribute("axis");
}
if(handednessElement)
{
s_handedness = handednessElement->getAttribute("val");
}
if(originElement)
{
s_origin = originElement->getAttribute("val");
}
//Convert to input types
PointingAlong alongBeam = axisNameToAxisType(s_alongBeam);
PointingAlong pointingUp = axisNameToAxisType(s_pointingUp);
Handedness handedness = s_handedness.compare("right") == 0 ? Right : Left;
//Overwrite the default reference frame.
m_instrument->setReferenceFrame(boost::shared_ptr<ReferenceFrame>(new ReferenceFrame(pointingUp, alongBeam, handedness, s_origin)));
}
}
std::vector<std::string> InstrumentDefinitionParser::buildExcludeList(const Poco::XML::Element* const location)
{
// check if <exclude> sub-elements for this location and create new exclude list to pass on
Poco::AutoPtr<NodeList> pNLexclude = location->getElementsByTagName("exclude");
unsigned long numberExcludeEle = pNLexclude->length();
std::vector<std::string> newExcludeList;
for (unsigned long i = 0; i < numberExcludeEle; i++)
{
Element* pExElem = static_cast<Element*>(pNLexclude->item(i));
if ( pExElem->hasAttribute("sub-part") )
newExcludeList.push_back(pExElem->getAttribute("sub-part"));
}
return newExcludeList;
}
//-----------------------------------------------------------------------------------------------------------------------
/** Assumes second argument is a XML location element and its parent is a component element
* which is assigned to be an assembly. This method appends the parent component element of
* the location element to the CompAssembly passed as the 1st arg. Note this method may call
* itself, i.e. it may act recursively.
*
* @param parent :: CompAssembly to append new component to
* @param pLocElem :: Poco::XML element that points to a location element in an instrument description XML file, which optionally may be detached (meaning it is not required to be part of the DOM tree of the IDF)
* @param pCompElem :: The Poco::XML \<component\> element that contains the \<location\> element
* @param idList :: The current IDList
*/
void InstrumentDefinitionParser::appendAssembly(Geometry::ICompAssembly* parent, const Poco::XML::Element* pLocElem, const Poco::XML::Element* pCompElem, IdList& idList)
{
const std::string filename = m_xmlFile->getFileFullPathStr();
// The location element is required to be a child of a component element. Get this component element
//Element* pCompElem = InstrumentDefinitionParser::getParentComponent(pLocElem);
// Read detector IDs into idlist if required
// Note idlist may be defined for any component
// Note any new idlist found will take precedence.
if ( pCompElem->hasAttribute("idlist") )
{
std::string idlist = pCompElem->getAttribute("idlist");
if ( idlist.compare(idList.idname) )
{
Element* pFound = pCompElem->ownerDocument()->getElementById(idlist, "idname");
if ( pFound == NULL )
{
throw Kernel::Exception::InstrumentDefinitionError(
"No <idlist> with name idname=\"" + idlist + "\" present in instrument definition file.", filename);
}
idList.reset();
populateIdList(pFound, idList);
}
}
//Create the assembly that will be appended into the parent.
Geometry::ICompAssembly *ass;
// The newly added component is required to have a type. Find out what this
// type is and find all the location elements of this type. Finally loop over these
// location elements
Element* pType = getTypeElement[pCompElem->getAttribute("type")];
if (pType->hasAttribute("outline") && pType->getAttribute("outline") != "no")
{
ass = new Geometry::ObjCompAssembly(InstrumentDefinitionParser::getNameOfLocationElement(pLocElem, pCompElem),parent);
}
else
{
ass = new Geometry::CompAssembly(InstrumentDefinitionParser::getNameOfLocationElement(pLocElem, pCompElem),parent);
}