ome-xml 5.2.0

- Main Page
- Related Pages
- Namespaces
- Classes
- Files

- File List

Pixels.h
1 /*
2 * #%L
3 * OME-XML C++ library for working with OME-XML metadata structures.
4 * %%
5 * Copyright © 2006 - 2016 Open Microscopy Environment:
6 * - Massachusetts Institute of Technology
7 * - National Institutes of Health
8 * - University of Dundee
9 * - Board of Regents of the University of Wisconsin-Madison
10 * - Glencoe Software, Inc.
11 * %%
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions are met:
14 *
15 * 1. Redistributions of source code must retain the above copyright notice,
16 * this list of conditions and the following disclaimer.
17 * 2. Redistributions in binary form must reproduce the above copyright notice,
18 * this list of conditions and the following disclaimer in the documentation
19 * and/or other materials provided with the distribution.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
22 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
25 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
30 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31 * POSSIBILITY OF SUCH DAMAGE.
32 *
33 * The views and conclusions contained in the software and documentation are
34 * those of the authors and should not be interpreted as representing official
35 * policies, either expressed or implied, of any organization.
36 * #L%
37 */
38
39 /*─────────────────────────────────────────────────────────────────────────────
40 *
41 * THIS IS AUTOMATICALLY GENERATED CODE. DO NOT MODIFY.
42 *
43 *─────────────────────────────────────────────────────────────────────────────
44 */
45
46 #ifndef OME_XML_MODEL_PIXELS_H
47 #define OME_XML_MODEL_PIXELS_H
48
49 #include <algorithm>
50 #include <list>
51 #include <stdexcept>
52 #include <string>
53 #include <vector>
54
55 #include <ome/common/log.h>
56
57 #include <ome/common/xml/dom/Document.h>
58 #include <ome/common/xml/dom/Element.h>
59 #include <ome/common/xml/dom/Node.h>
60 #include <ome/common/xml/dom/NodeList.h>
61
62 #include <ome/xml/model/MetadataOnly.h>
63 #include <ome/xml/model/detail/OMEModelObject.h>
64 #include <ome/xml/model/enums/DimensionOrder.h>
65 #include <ome/xml/model/enums/PixelType.h>
66 #include <ome/xml/model/primitives/PositiveFloat.h>
67 #include <ome/xml/model/primitives/PositiveInteger.h>
68
69 namespace ome
70 {
71 namespace xml
72 {
73 namespace model
74 {
75
76 // Forward declarations.
77 class Annotation;
78 class BinData;
79 class Channel;
80 class OMEModel;
81 class Plane;
82 class TiffData;
83
87 class Pixels : public detail::OMEModelObject
88 {
89 private:
90 class Impl;
92 ome::compat::shared_ptr<Impl> impl;
93
94 public:
96 Pixels();
97
103 Pixels (const Pixels& copy);
104
106 virtual
107 ~Pixels ();
108
123 static ome::compat::shared_ptr< Pixels>
124 create(const common::xml::dom::Element& element,
125 ome::xml::model::OMEModel& model);
126
127 // Documented in superclass.
128 const std::string&
129 elementName() const;
130
131 // Documented in superclass.
132 bool
133 validElementName(const std::string& name) const;
134
135
136 // -- OMEModelObject API methods --
137
139 virtual void
140 update(const common::xml::dom::Element& element,
141 ome::xml::model::OMEModel& model);
142
143 public:
144 // -- Pixels API methods --
145
147 bool
148 link (ome::compat::shared_ptr<Reference>& reference,
149 ome::compat::shared_ptr< ome::xml::model::OMEModelObject>& object);
150
156 const ome::xml::model::primitives::PositiveInteger&
157 getSizeT () const;
158
164 void
165 setSizeT (const ome::xml::model::primitives::PositiveInteger& sizeT);
166
172 ome::xml::model::enums::DimensionOrder&
173 getDimensionOrder ();
174
180 const ome::xml::model::enums::DimensionOrder&
181 getDimensionOrder () const;
182
188 void
189 setDimensionOrder (const ome::xml::model::enums::DimensionOrder& dimensionOrder);
190
196 ome::compat::shared_ptr<double>
197 getTimeIncrement ();
198
204 const ome::compat::shared_ptr<double>
205 getTimeIncrement () const;
206
212 void
213 setTimeIncrement (ome::compat::shared_ptr<double>& timeIncrement);
214
220 ome::compat::shared_ptr<ome::xml::model::primitives::PositiveFloat>
221 getPhysicalSizeY ();
222
228 const ome::compat::shared_ptr<ome::xml::model::primitives::PositiveFloat>
229 getPhysicalSizeY () const;
230
236 void
237 setPhysicalSizeY (ome::compat::shared_ptr<ome::xml::model::primitives::PositiveFloat>& physicalSizeY);
238
244 ome::compat::shared_ptr<ome::xml::model::primitives::PositiveFloat>
245 getPhysicalSizeX ();
246
252 const ome::compat::shared_ptr<ome::xml::model::primitives::PositiveFloat>
253 getPhysicalSizeX () const;
254
260 void
261 setPhysicalSizeX (ome::compat::shared_ptr<ome::xml::model::primitives::PositiveFloat>& physicalSizeX);
262
268 ome::compat::shared_ptr<ome::xml::model::primitives::PositiveFloat>
269 getPhysicalSizeZ ();
270
276 const ome::compat::shared_ptr<ome::xml::model::primitives::PositiveFloat>
277 getPhysicalSizeZ () const;
278
284 void
285 setPhysicalSizeZ (ome::compat::shared_ptr<ome::xml::model::primitives::PositiveFloat>& physicalSizeZ);
286
292 const ome::xml::model::primitives::PositiveInteger&
293 getSizeX () const;
294
300 void
301 setSizeX (const ome::xml::model::primitives::PositiveInteger& sizeX);
302
308 const ome::xml::model::primitives::PositiveInteger&
309 getSizeY () const;
310
316 void
317 setSizeY (const ome::xml::model::primitives::PositiveInteger& sizeY);
318
324 const ome::xml::model::primitives::PositiveInteger&
325 getSizeZ () const;
326
332 void
333 setSizeZ (const ome::xml::model::primitives::PositiveInteger& sizeZ);
334
340 ome::compat::shared_ptr<bool>
341 getBigEndian ();
342
348 const ome::compat::shared_ptr<bool>
349 getBigEndian () const;
350
356 void
357 setBigEndian (ome::compat::shared_ptr<bool>& bigEndian);
358
364 ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger>
365 getSignificantBits ();
366
372 const ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger>
373 getSignificantBits () const;
374
380 void
381 setSignificantBits (ome::compat::shared_ptr<ome::xml::model::primitives::PositiveInteger>& significantBits);
382
388 const ome::xml::model::primitives::PositiveInteger&
389 getSizeC () const;
390
396 void
397 setSizeC (const ome::xml::model::primitives::PositiveInteger& sizeC);
398
404 ome::xml::model::enums::PixelType&
405 getType ();
406
412 const ome::xml::model::enums::PixelType&
413 getType () const;
414
420 void
421 setType (const ome::xml::model::enums::PixelType& type);
422
428 const std::string&
429 getID () const;
430
436 void
437 setID (const std::string& id);
438
444 ome::compat::shared_ptr<bool>
445 getInterleaved ();
446
452 const ome::compat::shared_ptr<bool>
453 getInterleaved () const;
454
460 void
461 setInterleaved (ome::compat::shared_ptr<bool>& interleaved);
462
468 std::vector<ome::compat::shared_ptr<ome::xml::model::Channel> >::size_type
469 sizeOfChannelList () const;
470
477 std::vector<ome::compat::shared_ptr<ome::xml::model::Channel> >&
478 getChannelList ();
479
486 const std::vector<ome::compat::shared_ptr<ome::xml::model::Channel> >&
487 getChannelList () const;
488
496 ome::compat::shared_ptr<ome::xml::model::Channel>&
497 getChannel (std::vector<ome::compat::shared_ptr<ome::xml::model::Channel> >::size_type index);
498
506 const ome::compat::shared_ptr<ome::xml::model::Channel>&
507 getChannel (std::vector<ome::compat::shared_ptr<ome::xml::model::Channel> >::size_type index) const;
508
516 void
517 setChannel (std::vector<ome::compat::shared_ptr<ome::xml::model::Channel> >::size_type index,
518 ome::compat::shared_ptr<ome::xml::model::Channel>& channel);
519
528 void
529 addChannel (ome::compat::shared_ptr<ome::xml::model::Channel>& channel);
530
540 void
541 removeChannel (ome::compat::shared_ptr<ome::xml::model::Channel>& channel);
542
548 std::vector<ome::compat::shared_ptr<ome::xml::model::BinData> >::size_type
549 sizeOfBinDataList () const;
550
557 std::vector<ome::compat::shared_ptr<ome::xml::model::BinData> >&
558 getBinDataList ();
559
566 const std::vector<ome::compat::shared_ptr<ome::xml::model::BinData> >&
567 getBinDataList () const;
568
576 ome::compat::shared_ptr<ome::xml::model::BinData>&
577 getBinData (std::vector<ome::compat::shared_ptr<ome::xml::model::BinData> >::size_type index);
578
586 const ome::compat::shared_ptr<ome::xml::model::BinData>&
587 getBinData (std::vector<ome::compat::shared_ptr<ome::xml::model::BinData> >::size_type index) const;
588
596 void
597 setBinData (std::vector<ome::compat::shared_ptr<ome::xml::model::BinData> >::size_type index,
598 ome::compat::shared_ptr<ome::xml::model::BinData>& binData);
599
608 void
609 addBinData (ome::compat::shared_ptr<ome::xml::model::BinData>& binData);
610
620 void
621 removeBinData (ome::compat::shared_ptr<ome::xml::model::BinData>& binData);
622
628 std::vector<ome::compat::shared_ptr<ome::xml::model::TiffData> >::size_type
629 sizeOfTiffDataList () const;
630
637 std::vector<ome::compat::shared_ptr<ome::xml::model::TiffData> >&
638 getTiffDataList ();
639
646 const std::vector<ome::compat::shared_ptr<ome::xml::model::TiffData> >&
647 getTiffDataList () const;
648
656 ome::compat::shared_ptr<ome::xml::model::TiffData>&
657 getTiffData (std::vector<ome::compat::shared_ptr<ome::xml::model::TiffData> >::size_type index);
658
666 const ome::compat::shared_ptr<ome::xml::model::TiffData>&
667 getTiffData (std::vector<ome::compat::shared_ptr<ome::xml::model::TiffData> >::size_type index) const;
668
676 void
677 setTiffData (std::vector<ome::compat::shared_ptr<ome::xml::model::TiffData> >::size_type index,
678 ome::compat::shared_ptr<ome::xml::model::TiffData>& tiffData);
679
688 void
689 addTiffData (ome::compat::shared_ptr<ome::xml::model::TiffData>& tiffData);
690
700 void
701 removeTiffData (ome::compat::shared_ptr<ome::xml::model::TiffData>& tiffData);
702
708 ome::compat::shared_ptr<ome::xml::model::MetadataOnly>
709 getMetadataOnly ();
710
716 const ome::compat::shared_ptr<ome::xml::model::MetadataOnly>
717 getMetadataOnly () const;
718
724 void
725 setMetadataOnly (ome::compat::shared_ptr<ome::xml::model::MetadataOnly>& metadataOnly);
726
732 std::vector<ome::compat::shared_ptr<ome::xml::model::Plane> >::size_type
733 sizeOfPlaneList () const;
734
741 std::vector<ome::compat::shared_ptr<ome::xml::model::Plane> >&
742 getPlaneList ();
743
750 const std::vector<ome::compat::shared_ptr<ome::xml::model::Plane> >&
751 getPlaneList () const;
752
760 ome::compat::shared_ptr<ome::xml::model::Plane>&
761 getPlane (std::vector<ome::compat::shared_ptr<ome::xml::model::Plane> >::size_type index);
762
770 const ome::compat::shared_ptr<ome::xml::model::Plane>&
771 getPlane (std::vector<ome::compat::shared_ptr<ome::xml::model::Plane> >::size_type index) const;
772
780 void
781 setPlane (std::vector<ome::compat::shared_ptr<ome::xml::model::Plane> >::size_type index,
782 ome::compat::shared_ptr<ome::xml::model::Plane>& plane);
783
792 void
793 addPlane (ome::compat::shared_ptr<ome::xml::model::Plane>& plane);
794
804 void
805 removePlane (ome::compat::shared_ptr<ome::xml::model::Plane>& plane);
806
812 OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type::size_type
813 sizeOfLinkedAnnotationList () const;
814
820 OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type
821 getLinkedAnnotationList () const;
822
830 const ome::compat::weak_ptr<ome::xml::model::Annotation>&
831 getLinkedAnnotation (OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type::size_type index) const;
832
843 const ome::compat::weak_ptr<ome::xml::model::Annotation>&
844 setLinkedAnnotation (OMEModelObject::indexed_container<ome::xml::model::Annotation, ome::compat::weak_ptr>::type::size_type index,
845 const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
846
857 bool
858 linkAnnotation (const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
859
875 bool
876 unlinkAnnotation (const ome::compat::shared_ptr<ome::xml::model::Annotation>& annotation);
877
878
880 virtual common::xml::dom::Element
881 asXMLElement (common::xml::dom::Document& document) const;
882
883
884 protected:
885 // Documented in base class.
886 virtual common::xml::dom::Element
887 asXMLElementInternal (common::xml::dom::Document& document,
888 common::xml::dom::Element& element) const;
889
890 public:
891 // Documented in superclass.
892 const std::string&
893 getXMLNamespace() const;
894 };
895
896 }
897 }
898 }
899
900 #endif // OME_XML_MODEL_PIXELS_H
901
902 /*
903 * Local Variables:
904 * mode:C++
905 * End:
906 */
ome::xml::model::Pixels::Impl
Private implementation details of Pixels model object.
Definition: Pixels.cpp:100
ome::xml::model::OMEModel
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
ome::xml::model::Pixels::getID
const std::string & getID() const
Get the ID property.
Definition: Pixels.cpp:821
ome::xml::model::Pixels::addBinData
void addBinData(ome::compat::shared_ptr< ome::xml::model::BinData > &binData)
Add BinData.
Definition: Pixels.cpp:953
ome::xml::model::Pixels::sizeOfChannelList
std::vector< ome::compat::shared_ptr< ome::xml::model::Channel > >::size_type sizeOfChannelList() const
Get size of linked Channel list.
Definition: Pixels.cpp:856
ome::xml::model::Pixels::sizeOfLinkedAnnotationList
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type::size_type sizeOfLinkedAnnotationList() const
Get size of linked Annotation list.
Definition: Pixels.cpp:1109
ome::xml::model::Pixels::setMetadataOnly
void setMetadataOnly(ome::compat::shared_ptr< ome::xml::model::MetadataOnly > &metadataOnly)
Set the MetadataOnly property.
Definition: Pixels.cpp:1044
ome::xml::model::Pixels::setTimeIncrement
void setTimeIncrement(ome::compat::shared_ptr< double > &timeIncrement)
Set the TimeIncrement property.
Definition: Pixels.cpp:632
ome::xml::model::Pixels::linkAnnotation
bool linkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Link Annotation.
Definition: Pixels.cpp:1137
ome::xml::model::Pixels::getSizeX
const ome::xml::model::primitives::PositiveInteger & getSizeX() const
Get the SizeX property.
Definition: Pixels.cpp:702
ome::xml::model::Pixels::getSignificantBits
ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > getSignificantBits()
Get the SignificantBits property.
Definition: Pixels.cpp:765
ome::xml::model::Pixels::getSizeC
const ome::xml::model::primitives::PositiveInteger & getSizeC() const
Get the SizeC property.
Definition: Pixels.cpp:786
ome::xml::model::Pixels::setBinData
void setBinData(std::vector< ome::compat::shared_ptr< ome::xml::model::BinData > >::size_type index, ome::compat::shared_ptr< ome::xml::model::BinData > &binData)
Set BinData.
Definition: Pixels.cpp:944
ome::xml::model::Pixels::validElementName
bool validElementName(const std::string &name) const
Check if a given element name is valid for processing by this model object.
Definition: Pixels.cpp:322
ome::xml::model::Pixels::addTiffData
void addTiffData(ome::compat::shared_ptr< ome::xml::model::TiffData > &tiffData)
Add TiffData.
Definition: Pixels.cpp:1011
ome::xml::model::Pixels::link
bool link(ome::compat::shared_ptr< Reference > &reference, ome::compat::shared_ptr< ome::xml::model::OMEModelObject > &object)
Link a given OME model object to this model object.
Definition: Pixels.cpp:552
ome::xml::model::Pixels::getPhysicalSizeZ
ome::compat::shared_ptr< ome::xml::model::primitives::PositiveFloat > getPhysicalSizeZ()
Get the PhysicalSizeZ property.
Definition: Pixels.cpp:681
ome::xml::model::Pixels::Pixels
Pixels()
Default constructor.
Definition: Pixels.cpp:282
ome::xml::model::Pixels::~Pixels
virtual ~Pixels()
Destructor.
Definition: Pixels.cpp:301
ome::xml::model::Pixels::setType
void setType(const ome::xml::model::enums::PixelType &type)
Set the Type property.
Definition: Pixels.cpp:814
ome::xml::model::Pixels::getLinkedAnnotationList
OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type getLinkedAnnotationList() const
Get the linked Annotation list.
Definition: Pixels.cpp:1115
ome::xml::model::Pixels::setPlane
void setPlane(std::vector< ome::compat::shared_ptr< ome::xml::model::Plane > >::size_type index, ome::compat::shared_ptr< ome::xml::model::Plane > &plane)
Set Plane.
Definition: Pixels.cpp:1081
ome::xml::model::Pixels::removeBinData
void removeBinData(ome::compat::shared_ptr< ome::xml::model::BinData > &binData)
Remove BinData.
Definition: Pixels.cpp:961
ome::xml::model::Pixels::sizeOfPlaneList
std::vector< ome::compat::shared_ptr< ome::xml::model::Plane > >::size_type sizeOfPlaneList() const
Get size of linked Plane list.
Definition: Pixels.cpp:1051
ome::xml::model::Pixels::removeTiffData
void removeTiffData(ome::compat::shared_ptr< ome::xml::model::TiffData > &tiffData)
Remove TiffData.
Definition: Pixels.cpp:1019
ome::xml::model::Pixels::setPhysicalSizeX
void setPhysicalSizeX(ome::compat::shared_ptr< ome::xml::model::primitives::PositiveFloat > &physicalSizeX)
Set the PhysicalSizeX property.
Definition: Pixels.cpp:674
ome::common::xml::dom::Document
ome::xml::model::Pixels::getPhysicalSizeY
ome::compat::shared_ptr< ome::xml::model::primitives::PositiveFloat > getPhysicalSizeY()
Get the PhysicalSizeY property.
Definition: Pixels.cpp:639
ome::common::xml::dom::Element
ome::xml::model::detail::OMEModelObject
OME model object (concrete implementation).
Definition: OMEModelObject.h:64
ome::xml::model::Pixels::getPlaneList
std::vector< ome::compat::shared_ptr< ome::xml::model::Plane > > & getPlaneList()
Get the Plane list.
Definition: Pixels.cpp:1057
ome::xml::model::OMEModelObject::indexed_container::type
boost::multi_index_container< Ptr< T >, boost::multi_index::indexed_by< boost::multi_index::random_access<>, boost::multi_index::ordered_unique< boost::multi_index::identity< Ptr< T > >, ome::compat::owner_less< Ptr< T > > > > > type
Multi-index container type.
Definition: OMEModelObject.h:94
ome::xml::model::Pixels::setSizeZ
void setSizeZ(const ome::xml::model::primitives::PositiveInteger &sizeZ)
Set the SizeZ property.
Definition: Pixels.cpp:737
ome::xml::model::Pixels::addChannel
void addChannel(ome::compat::shared_ptr< ome::xml::model::Channel > &channel)
Add Channel.
Definition: Pixels.cpp:895
ome::xml::model::Pixels::setPhysicalSizeY
void setPhysicalSizeY(ome::compat::shared_ptr< ome::xml::model::primitives::PositiveFloat > &physicalSizeY)
Set the PhysicalSizeY property.
Definition: Pixels.cpp:653
ome::xml::model::Pixels::impl
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: Pixels.h:90
ome::xml::model::Pixels::getXMLNamespace
const std::string & getXMLNamespace() const
Get the XML namespace for this model object.
Definition: Pixels.cpp:1442
ome::xml::model::Pixels::setSizeY
void setSizeY(const ome::xml::model::primitives::PositiveInteger &sizeY)
Set the SizeY property.
Definition: Pixels.cpp:723
ome::xml::model::Pixels::getType
ome::xml::model::enums::PixelType & getType()
Get the Type property.
Definition: Pixels.cpp:800
ome::xml::model::Pixels::getTiffDataList
std::vector< ome::compat::shared_ptr< ome::xml::model::TiffData > > & getTiffDataList()
Get the TiffData list.
Definition: Pixels.cpp:978
ome::xml::model::Pixels::setTiffData
void setTiffData(std::vector< ome::compat::shared_ptr< ome::xml::model::TiffData > >::size_type index, ome::compat::shared_ptr< ome::xml::model::TiffData > &tiffData)
Set TiffData.
Definition: Pixels.cpp:1002
ome::xml::model::Pixels::getTiffData
ome::compat::shared_ptr< ome::xml::model::TiffData > & getTiffData(std::vector< ome::compat::shared_ptr< ome::xml::model::TiffData > >::size_type index)
Get TiffData.
Definition: Pixels.cpp:990
ome::xml::model::Pixels::setLinkedAnnotation
const ome::compat::weak_ptr< ome::xml::model::Annotation > & setLinkedAnnotation(OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type::size_type index, const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Set linked Annotation.
Definition: Pixels.cpp:1127
ome::xml::model::enums::DimensionOrder
DimensionOrder enumeration.
Definition: DimensionOrder.h:72
ome::xml::model::Pixels::unlinkAnnotation
bool unlinkAnnotation(const ome::compat::shared_ptr< ome::xml::model::Annotation > &annotation)
Unlink Annotation.
Definition: Pixels.cpp:1151
ome::xml::model::Pixels::getPhysicalSizeX
ome::compat::shared_ptr< ome::xml::model::primitives::PositiveFloat > getPhysicalSizeX()
Get the PhysicalSizeX property.
Definition: Pixels.cpp:660
ome::xml::model::OMEModelObject::indexed_container
Multi-index container for efficient ordered insertion and deletion of model object references...
Definition: OMEModelObject.h:85
ome::xml::model::Pixels::setDimensionOrder
void setDimensionOrder(const ome::xml::model::enums::DimensionOrder &dimensionOrder)
Set the DimensionOrder property.
Definition: Pixels.cpp:611
ome::xml::model::Pixels::sizeOfTiffDataList
std::vector< ome::compat::shared_ptr< ome::xml::model::TiffData > >::size_type sizeOfTiffDataList() const
Get size of linked TiffData list.
Definition: Pixels.cpp:972
ome
Open Microscopy Environment C++ implementation.
ome::xml::model::Pixels::getTimeIncrement
ome::compat::shared_ptr< double > getTimeIncrement()
Get the TimeIncrement property.
Definition: Pixels.cpp:618
ome::xml::model::Pixels::setSignificantBits
void setSignificantBits(ome::compat::shared_ptr< ome::xml::model::primitives::PositiveInteger > &significantBits)
Set the SignificantBits property.
Definition: Pixels.cpp:779
ome::xml::model::Pixels::getMetadataOnly
ome::compat::shared_ptr< ome::xml::model::MetadataOnly > getMetadataOnly()
Get the MetadataOnly property.
Definition: Pixels.cpp:1030
ome::xml::model::Pixels
Pixels model object.
Definition: Pixels.h:87
ome::xml::model::Pixels::update
virtual void update(const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
Update the object hierarchy recursively from an XML DOM tree.
Definition: Pixels.cpp:331
ome::xml::model::Pixels::getSizeY
const ome::xml::model::primitives::PositiveInteger & getSizeY() const
Get the SizeY property.
Definition: Pixels.cpp:716
ome::xml::model::Pixels::addPlane
void addPlane(ome::compat::shared_ptr< ome::xml::model::Plane > &plane)
Add Plane.
Definition: Pixels.cpp:1090
ome::xml::model::Pixels::getInterleaved
ome::compat::shared_ptr< bool > getInterleaved()
Get the Interleaved property.
Definition: Pixels.cpp:835
ome::xml::model::Pixels::getSizeT
const ome::xml::model::primitives::PositiveInteger & getSizeT() const
Get the SizeT property.
Definition: Pixels.cpp:583
ome::xml::model::Pixels::setID
void setID(const std::string &id)
Set the ID property.
Definition: Pixels.cpp:828
ome::xml::model::Pixels::create
static ome::compat::shared_ptr< Pixels > create(const common::xml::dom::Element &element, ome::xml::model::OMEModel &model)
Create a Pixels model object from DOM element.
Definition: Pixels.cpp:306
ome::xml::model::enums::PixelType
PixelType enumeration.
Definition: PixelType.h:72
ome::xml::model::Pixels::getChannel
ome::compat::shared_ptr< ome::xml::model::Channel > & getChannel(std::vector< ome::compat::shared_ptr< ome::xml::model::Channel > >::size_type index)
Get Channel.
Definition: Pixels.cpp:874
ome::xml::model::Pixels::getBinDataList
std::vector< ome::compat::shared_ptr< ome::xml::model::BinData > > & getBinDataList()
Get the BinData list.
Definition: Pixels.cpp:920
ome::xml::model::Pixels::setSizeC
void setSizeC(const ome::xml::model::primitives::PositiveInteger &sizeC)
Set the SizeC property.
Definition: Pixels.cpp:793
ome::xml::model::Pixels::getPlane
ome::compat::shared_ptr< ome::xml::model::Plane > & getPlane(std::vector< ome::compat::shared_ptr< ome::xml::model::Plane > >::size_type index)
Get Plane.
Definition: Pixels.cpp:1069
ome::xml::model::Pixels::getSizeZ
const ome::xml::model::primitives::PositiveInteger & getSizeZ() const
Get the SizeZ property.
Definition: Pixels.cpp:730
ome::xml::model::Pixels::setSizeT
void setSizeT(const ome::xml::model::primitives::PositiveInteger &sizeT)
Set the SizeT property.
Definition: Pixels.cpp:590
ome::xml::model::Pixels::removeChannel
void removeChannel(ome::compat::shared_ptr< ome::xml::model::Channel > &channel)
Remove Channel.
Definition: Pixels.cpp:903
ome::xml::model::Pixels::elementName
const std::string & elementName() const
Get the element name of this model object.
Definition: Pixels.cpp:315
ome::xml::model::Pixels::setChannel
void setChannel(std::vector< ome::compat::shared_ptr< ome::xml::model::Channel > >::size_type index, ome::compat::shared_ptr< ome::xml::model::Channel > &channel)
Set Channel.
Definition: Pixels.cpp:886
ome::xml::model::Pixels::getBigEndian
ome::compat::shared_ptr< bool > getBigEndian()
Get the BigEndian property.
Definition: Pixels.cpp:744
ome::xml::model::Pixels::asXMLElementInternal
virtual common::xml::dom::Element asXMLElementInternal(common::xml::dom::Document &document, common::xml::dom::Element &element) const
Transform the object hierarchy rooted at this element to XML.
Definition: Pixels.cpp:1176
ome::xml::model::Pixels::setPhysicalSizeZ
void setPhysicalSizeZ(ome::compat::shared_ptr< ome::xml::model::primitives::PositiveFloat > &physicalSizeZ)
Set the PhysicalSizeZ property.
Definition: Pixels.cpp:695
log.h
ome::xml::model::Pixels::getDimensionOrder
ome::xml::model::enums::DimensionOrder & getDimensionOrder()
Get the DimensionOrder property.
Definition: Pixels.cpp:597
ome::xml::model::Pixels::getBinData
ome::compat::shared_ptr< ome::xml::model::BinData > & getBinData(std::vector< ome::compat::shared_ptr< ome::xml::model::BinData > >::size_type index)
Get BinData.
Definition: Pixels.cpp:932
ome::xml::model::Pixels::getChannelList
std::vector< ome::compat::shared_ptr< ome::xml::model::Channel > > & getChannelList()
Get the Channel list.
Definition: Pixels.cpp:862
ome::xml::model::Pixels::asXMLElement
virtual common::xml::dom::Element asXMLElement(common::xml::dom::Document &document) const
Transform the object hierarchy rooted at this element to XML.
Definition: Pixels.cpp:1169
ome::xml::model::Pixels::sizeOfBinDataList
std::vector< ome::compat::shared_ptr< ome::xml::model::BinData > >::size_type sizeOfBinDataList() const
Get size of linked BinData list.
Definition: Pixels.cpp:914
ome::xml::model::primitives::ConstrainedNumeric
A numeric type constrained to a subrange (or subranges) of its range limits.
Definition: ConstrainedNumeric.h:119
ome::xml::model::Pixels::removePlane
void removePlane(ome::compat::shared_ptr< ome::xml::model::Plane > &plane)
Remove Plane.
Definition: Pixels.cpp:1098
ome::xml::model::Pixels::setInterleaved
void setInterleaved(ome::compat::shared_ptr< bool > &interleaved)
Set the Interleaved property.
Definition: Pixels.cpp:849
ome::xml::model::Pixels::getLinkedAnnotation
const ome::compat::weak_ptr< ome::xml::model::Annotation > & getLinkedAnnotation(OMEModelObject::indexed_container< ome::xml::model::Annotation, ome::compat::weak_ptr >::type::size_type index) const
Get linked Annotation.
Definition: Pixels.cpp:1121
ome::xml::model::Pixels::setSizeX
void setSizeX(const ome::xml::model::primitives::PositiveInteger &sizeX)
Set the SizeX property.
Definition: Pixels.cpp:709
ome::xml::model::Pixels::setBigEndian
void setBigEndian(ome::compat::shared_ptr< bool > &bigEndian)
Set the BigEndian property.
Definition: Pixels.cpp:758