Bases: NBOBaseClass
Represents the XML element OME.
The OME element is a container for all information objects accessible by OME. These information objects include descriptions of the imaging experiments and the people who perform them, descriptions of the microscope, the resulting images and how they were acquired, the analyses performed on those images, and the analysis results themselves. An OME file may contain any or all of this information. With the creation of the Metadata Only Companion OME-XML and Binary Only OME-TIFF files the top level OME node has changed slightly. It can EITHER: Contain all the previously expected elements OR: Contain a single BinaryOnly element that points at its Metadata Only Companion OME-XML file.
fromBase ( base )
staticmethod
fromJsonFile ( path , validate = True )
fromJsonString ( json_string , validate = True )
fromXmlFile ( path , validate = True )
fromXmlString ( xml_string , validate = True )
toXmlFile ( filename , validate = True )
toXmlString ( validate = True )
setUUID ( value , validate = True )
Sets the value of the UUID attribute.
This unique identifier is used to keep track of multi part files. It allows the links between files to survive renaming. While OPTIONAL in the general case this is REQUIRED in a MetadataOnly Companion to a collection of BinaryOnly files.
Parameters:
Name
Type
Description
Default
value
UniversallyUniqueIdentifier_Type
required
validate
(boolean , optional )
If true, validates constraints on value. Default is true.
True
getUUID ()
Returns the value of the UUID attribute.
This unique identifier is used to keep track of multi part files. It allows the links between files to survive renaming. While OPTIONAL in the general case this is REQUIRED in a MetadataOnly Companion to a collection of BinaryOnly files.
Returns:
Type
Description
UniversallyUniqueIdentifier_Type
The value of the attribute
resetUUID ()
Resets the UUID attribute to an unset state.
This unique identifier is used to keep track of multi part files. It allows the links between files to survive renaming. While OPTIONAL in the general case this is REQUIRED in a MetadataOnly Companion to a collection of BinaryOnly files.
hasUUID ()
Checks whether the optional UUID attribute is present.
This unique identifier is used to keep track of multi part files. It allows the links between files to survive renaming. While OPTIONAL in the general case this is REQUIRED in a MetadataOnly Companion to a collection of BinaryOnly files.
Returns:
Type
Description
boolean
true if the optional attribute has been set, false otherwise
setCreator ( value , validate = True )
Sets the value of the Creator attribute.
This is the name of the creating application of the OME-XML and preferably its full version. e.g "CompanyName, SoftwareName, V2.6.3456" This is optional but we hope it will be set by applications writing out OME-XML from scratch.
Parameters:
Name
Type
Description
Default
value
string
required
validate
(boolean , optional )
If true, validates constraints on value. Default is true.
True
getCreator ()
Returns the value of the Creator attribute.
This is the name of the creating application of the OME-XML and preferably its full version. e.g "CompanyName, SoftwareName, V2.6.3456" This is optional but we hope it will be set by applications writing out OME-XML from scratch.
Returns:
Type
Description
string
The value of the attribute
resetCreator ()
Resets the Creator attribute to an unset state.
This is the name of the creating application of the OME-XML and preferably its full version. e.g "CompanyName, SoftwareName, V2.6.3456" This is optional but we hope it will be set by applications writing out OME-XML from scratch.
hasCreator ()
Checks whether the Creator attribute is present.
This is the name of the creating application of the OME-XML and preferably its full version. e.g "CompanyName, SoftwareName, V2.6.3456" This is optional but we hope it will be set by applications writing out OME-XML from scratch.
Returns:
Type
Description
boolean
true if the attribute has been set, false otherwise
getCreatorAllowedValues ()
staticmethod
Returns the allowed values for this attribut.
This is the name of the creating application of the OME-XML and preferably its full version. e.g "CompanyName, SoftwareName, V2.6.3456" This is optional but we hope it will be set by applications writing out OME-XML from scratch.
Returns:
Type
Description
std::set< str,std::less< str >,std::allocator< str > >
The list of allowed values
setRights ( value , validate = True )
setome_choice ( value , validate = True )