Fluorophore

Bases: ManufacturerSpec_Type

Represents the XML element Fluorophore.

This element describes the Fluorophore whose Emission is used to produce this Channel. [plain text string].

getTypeName()

Returns the class type name.

Returns:

Type	Description
string	The class type name

getXMLName()

Returns the XML element name corresponding to this class.

Returns:

Type	Description
string	The XML element name

getNBOType()

Returns the NBO Type corresponding to this class.

Returns:

Type	Description
int	The NBO Type value

getChildren()

Returns a list of all classes derived from this class.

Returns:

Type	Description
List[NBOBaseClass]	The list of derived classes

getSubElements()

Returns a list of all child elements contained in this class.

Returns:

Type	Description
List[NBOBaseClass]	The list of child classes

fromJsonFile(path)

Populates this object from a JSON file.

Parameters:

Name	Type	Description	Default
path	string	The path to the JSON file	required

fromJsonString(json_string)

Populates this object from a JSON string.

Parameters:

Name	Type	Description	Default
json_string	string	The JSON content as a string	required

fromXmlFile(path)

Populates this object from a XML file.

Parameters:

Name	Type	Description	Default
path	string	The path to the XML file	required

fromXmlString(xml_string)

Populates this object from a XML string.

Parameters:

Name	Type	Description	Default
xml_string	string	The XML content as a string	required

toXmlFile(filename)

Serializes this object to an XML file.

Parameters:

Name	Type	Description	Default
filename	string	The path to the output XML file	required

toXmlString()

Serializes this object to an XML string.

Returns:

Type	Description
string	A string containing the XML representation of this object

setID(value)

Sets the value of the ID attribute.

A Unique Identifier for this component.

Parameters:

Name	Type	Description	Default
value	LSID_Type	The value to set	required

getID()

Returns the value of the ID attribute.

A Unique Identifier for this component.

Returns:

Type	Description
LSID_Type	The value of the attribute

resetID()

Resets the ID attribute to an unset state.

A Unique Identifier for this component.

hasID()

Checks whether the optional ID attribute is present.

A Unique Identifier for this component.

Returns:

Type	Description
boolean	true if the optional attribute has been set, false otherwise

setName(value)

Sets the value of the Name attribute.

This field records a descriptive term that designates this Fluorophore as specified by the Manufacturer. For example, it might be the name of a specific Fluorescence Protein variant, or the name used by the Manufactuer for an organic dye.

Parameters:

Name	Type	Description	Default
value	Denomination_Type	The value to set	required

getName()

Returns the value of the Name attribute.

This field records a descriptive term that designates this Fluorophore as specified by the Manufacturer. For example, it might be the name of a specific Fluorescence Protein variant, or the name used by the Manufactuer for an organic dye.

Returns:

Type	Description
Denomination_Type	The value of the attribute

resetName()

Resets the Name attribute to an unset state.

This field records a descriptive term that designates this Fluorophore as specified by the Manufacturer. For example, it might be the name of a specific Fluorescence Protein variant, or the name used by the Manufactuer for an organic dye.

hasName()

Checks whether the optional Name attribute is present.

This field records a descriptive term that designates this Fluorophore as specified by the Manufacturer. For example, it might be the name of a specific Fluorescence Protein variant, or the name used by the Manufactuer for an organic dye.

Returns:

Type	Description
boolean	true if the optional attribute has been set, false otherwise

setType(value)

Sets the value of the Type attribute.

This field records a term that describes the general category of the Fluorescent Label used in this case.

Parameters:

Name	Type	Description	Default
value	FluorescentLabelType_Type	The value to set	required

getType()

Returns the value of the Type attribute.

This field records a term that describes the general category of the Fluorescent Label used in this case.

Returns:

Type	Description
FluorescentLabelType_Type	The value of the attribute

resetType()

Resets the Type attribute to an unset state.

This field records a term that describes the general category of the Fluorescent Label used in this case.

hasType()

Checks whether the optional Type attribute is present.

This field records a term that describes the general category of the Fluorescent Label used in this case.

Returns:

Type	Description
boolean	true if the optional attribute has been set, false otherwise

setExcitationWavelength(value)

Sets the value of the ExcitationWavelength attribute.

This field records the Excitation Wavelength used for this Channel.

Parameters:

Name	Type	Description	Default
value	PositiveFloat_Type	The value to set	required

getExcitationWavelength()

Returns the value of the ExcitationWavelength attribute.

This field records the Excitation Wavelength used for this Channel.

Returns:

Type	Description
PositiveFloat_Type	The value of the attribute

resetExcitationWavelength()

Resets the ExcitationWavelength attribute to an unset state.

This field records the Excitation Wavelength used for this Channel.

hasExcitationWavelength()

Checks whether the optional ExcitationWavelength attribute is present.

This field records the Excitation Wavelength used for this Channel.

Returns:

Type	Description
boolean	true if the optional attribute has been set, false otherwise

setExcitationWavelengthUnit(value)

Sets the value of the ExcitationWavelengthUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsLength_Type	The value to set	required

getExcitationWavelengthUnit()

Returns the value of the ExcitationWavelengthUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsLength_Type	The value of the attribute

resetExcitationWavelengthUnit()

Resets the ExcitationWavelengthUnit attribute to an unset state.

No description available in the XSD standard.

hasExcitationWavelengthUnit()

Checks whether the optional ExcitationWavelengthUnit attribute is present.

No description available in the XSD standard.

Returns:

Type	Description
boolean	true if the optional attribute has been set, false otherwise

setEmissionWavelength(value)

Sets the value of the EmissionWavelength attribute.

This field records the Emission Wavelength used for this Channel.

Parameters:

Name	Type	Description	Default
value	PositiveFloat_Type	The value to set	required

getEmissionWavelength()

Returns the value of the EmissionWavelength attribute.

This field records the Emission Wavelength used for this Channel.

Returns:

Type	Description
PositiveFloat_Type	The value of the attribute

resetEmissionWavelength()

Resets the EmissionWavelength attribute to an unset state.

This field records the Emission Wavelength used for this Channel.

hasEmissionWavelength()

Checks whether the optional EmissionWavelength attribute is present.

This field records the Emission Wavelength used for this Channel.

Returns:

Type	Description
boolean	true if the optional attribute has been set, false otherwise

setEmissionWavelengthUnit(value)

Sets the value of the EmissionWavelengthUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsLength_Type	The value to set	required

getEmissionWavelengthUnit()

Returns the value of the EmissionWavelengthUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsLength_Type	The value of the attribute

resetEmissionWavelengthUnit()

Resets the EmissionWavelengthUnit attribute to an unset state.

No description available in the XSD standard.

hasEmissionWavelengthUnit()

Checks whether the optional EmissionWavelengthUnit attribute is present.

No description available in the XSD standard.

Returns:

Type	Description
boolean	true if the optional attribute has been set, false otherwise

setConcentration(value)

Sets the value of the Concentration attribute.

If applicable (e.g., in the case of direct incubation of the sample with a specific label such as DAPI or Mitotracker Red), this field records the Concentration of this Fluorophore that was used to stain the Sample and that was imaged in this Channel.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getConcentration()

Returns the value of the Concentration attribute.

If applicable (e.g., in the case of direct incubation of the sample with a specific label such as DAPI or Mitotracker Red), this field records the Concentration of this Fluorophore that was used to stain the Sample and that was imaged in this Channel.

Returns:

Type	Description
float	The value of the attribute

resetConcentration()

Resets the Concentration attribute to an unset state.

If applicable (e.g., in the case of direct incubation of the sample with a specific label such as DAPI or Mitotracker Red), this field records the Concentration of this Fluorophore that was used to stain the Sample and that was imaged in this Channel.

hasConcentration()

Checks whether the optional Concentration attribute is present.

If applicable (e.g., in the case of direct incubation of the sample with a specific label such as DAPI or Mitotracker Red), this field records the Concentration of this Fluorophore that was used to stain the Sample and that was imaged in this Channel.

Returns:

Type	Description
boolean	true if the optional attribute has been set, false otherwise

setConcentrationUnit(value)

Sets the value of the ConcentrationUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsConcentration_Type	The value to set	required

getConcentrationUnit()

Returns the value of the ConcentrationUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsConcentration_Type	The value of the attribute

resetConcentrationUnit()

Resets the ConcentrationUnit attribute to an unset state.

No description available in the XSD standard.

hasConcentrationUnit()

Checks whether the optional ConcentrationUnit attribute is present.

No description available in the XSD standard.

Returns:

Type	Description
boolean	true if the optional attribute has been set, false otherwise

setFBBaseID(value)

Sets the value of the FBBaseID attribute.

In case the Fluorophore is a Fluorescent Protein, this field records its FPBaseID (FPBase.org).

Parameters:

Name	Type	Description	Default
value	string	The value to set	required

getFBBaseID()

Returns the value of the FBBaseID attribute.

In case the Fluorophore is a Fluorescent Protein, this field records its FPBaseID (FPBase.org).

Returns:

Type	Description
string	The value of the attribute

resetFBBaseID()

Resets the FBBaseID attribute to an unset state.

In case the Fluorophore is a Fluorescent Protein, this field records its FPBaseID (FPBase.org).

hasFBBaseID()

Checks whether the optional FBBaseID attribute is present.

In case the Fluorophore is a Fluorescent Protein, this field records its FPBaseID (FPBase.org).

Returns:

Type	Description
boolean	true if the optional attribute has been set, false otherwise

setPrimaryPublicationID(value)

Sets the value of the PrimaryPublicationID attribute.

This field captures the a Unique Identifier for the Primary Publication describing this Fluorescent Label. Examples include, Digital Object Identifier (DOI), PubMed Central Identifier (PMCID), ArXiv.org ID etc.

Parameters:

Name	Type	Description	Default
value	string	The value to set	required

getPrimaryPublicationID()

Returns the value of the PrimaryPublicationID attribute.

This field captures the a Unique Identifier for the Primary Publication describing this Fluorescent Label. Examples include, Digital Object Identifier (DOI), PubMed Central Identifier (PMCID), ArXiv.org ID etc.

Returns:

Type	Description
string	The value of the attribute

resetPrimaryPublicationID()

Resets the PrimaryPublicationID attribute to an unset state.

This field captures the a Unique Identifier for the Primary Publication describing this Fluorescent Label. Examples include, Digital Object Identifier (DOI), PubMed Central Identifier (PMCID), ArXiv.org ID etc.

hasPrimaryPublicationID()

Checks whether the optional PrimaryPublicationID attribute is present.

This field captures the a Unique Identifier for the Primary Publication describing this Fluorescent Label. Examples include, Digital Object Identifier (DOI), PubMed Central Identifier (PMCID), ArXiv.org ID etc.

Returns:

Type	Description
boolean	true if the optional attribute has been set, false otherwise