com.inscoper.nbo.Pixels¶

Represents the XML element Pixels. More...

Inherits from com.inscoper.nbo.NBOBaseClass

Public Functions¶

	Name
synchronized void	delete()
	Pixels()
String	getTypeName() Returns the class type name.
String	getXMLName() Returns the XML element name corresponding to this class.
ENBOType	getNBOType() Returns the NBO Type corresponding to this class.
NBOBaseClassVector	getChildren() Returns a list of all classes derived from this class.
NBOBaseClassVector	getSubElements() Returns a list of all child elements contained in this class.
void	fromJsonFile(String path, boolean validate) Populates this object from a JSON file.
void	fromJsonFile(String path) Populates this object from a JSON file.
void	fromJsonString(String json_string, boolean validate) Populates this object from a JSON string.
void	fromJsonString(String json_string) Populates this object from a JSON string.
void	fromXmlFile(String path, boolean validate) Populates this object from a XML file.
void	fromXmlFile(String path) Populates this object from a XML file.
void	fromXmlString(String xml_string, boolean validate) Populates this object from a XML string.
void	fromXmlString(String xml_string) Populates this object from a XML string.
void	toXmlFile(String filename, boolean validate) Serializes this object to an XML file.
void	toXmlFile(String filename) Serializes this object to an XML file.
String	toXmlString(boolean validate) Serializes this object to an XML string.
String	toXmlString() Serializes this object to an XML string.
void	setID(PixelsID_Type value, boolean validate) Sets the value of the ID attribute.
void	setID(PixelsID_Type value) Sets the value of the ID attribute.
PixelsID_Type	getID() Returns the value of the ID attribute.
void	resetID() Resets the ID attribute to an unset state.
boolean	hasID() Checks whether the optional ID attribute is present.
void	setDimensionOrder(PixelsDimensionOrder_Type value, boolean validate) Sets the value of the DimensionOrder attribute.
void	setDimensionOrder(PixelsDimensionOrder_Type value) Sets the value of the DimensionOrder attribute.
PixelsDimensionOrder_Type	getDimensionOrder() Returns the value of the DimensionOrder attribute.
void	resetDimensionOrder() Resets the DimensionOrder attribute to an unset state.
boolean	hasDimensionOrder() Checks whether the optional DimensionOrder attribute is present.
void	setSizeX(PositiveInt_Type value, boolean validate) Sets the value of the SizeX attribute.
void	setSizeX(PositiveInt_Type value) Sets the value of the SizeX attribute.
PositiveInt_Type	getSizeX() Returns the value of the SizeX attribute.
void	resetSizeX() Resets the SizeX attribute to an unset state.
boolean	hasSizeX() Checks whether the optional SizeX attribute is present.
void	setSizeY(PositiveInt_Type value, boolean validate) Sets the value of the SizeY attribute.
void	setSizeY(PositiveInt_Type value) Sets the value of the SizeY attribute.
PositiveInt_Type	getSizeY() Returns the value of the SizeY attribute.
void	resetSizeY() Resets the SizeY attribute to an unset state.
boolean	hasSizeY() Checks whether the optional SizeY attribute is present.
void	setSizeZ(PositiveInt_Type value, boolean validate) Sets the value of the SizeZ attribute.
void	setSizeZ(PositiveInt_Type value) Sets the value of the SizeZ attribute.
PositiveInt_Type	getSizeZ() Returns the value of the SizeZ attribute.
void	resetSizeZ() Resets the SizeZ attribute to an unset state.
boolean	hasSizeZ() Checks whether the optional SizeZ attribute is present.
void	setSizeC(PositiveInt_Type value, boolean validate) Sets the value of the SizeC attribute.
void	setSizeC(PositiveInt_Type value) Sets the value of the SizeC attribute.
PositiveInt_Type	getSizeC() Returns the value of the SizeC attribute.
void	resetSizeC() Resets the SizeC attribute to an unset state.
boolean	hasSizeC() Checks whether the optional SizeC attribute is present.
void	setSizeT(PositiveInt_Type value, boolean validate) Sets the value of the SizeT attribute.
void	setSizeT(PositiveInt_Type value) Sets the value of the SizeT attribute.
PositiveInt_Type	getSizeT() Returns the value of the SizeT attribute.
void	resetSizeT() Resets the SizeT attribute to an unset state.
boolean	hasSizeT() Checks whether the optional SizeT attribute is present.
void	setPhysicalSizeX(PositiveFloat_Type value, boolean validate) Sets the value of the PhysicalSizeX attribute.
void	setPhysicalSizeX(PositiveFloat_Type value) Sets the value of the PhysicalSizeX attribute.
PositiveFloat_Type	getPhysicalSizeX() Returns the value of the PhysicalSizeX attribute.
void	resetPhysicalSizeX() Resets the PhysicalSizeX attribute to an unset state.
boolean	hasPhysicalSizeX() Checks whether the optional PhysicalSizeX attribute is present.
void	setPhysicalSizeXUnit(UnitsLength_Type value, boolean validate) Sets the value of the PhysicalSizeXUnit attribute.
void	setPhysicalSizeXUnit(UnitsLength_Type value) Sets the value of the PhysicalSizeXUnit attribute.
UnitsLength_Type	getPhysicalSizeXUnit() Returns the value of the PhysicalSizeXUnit attribute.
void	resetPhysicalSizeXUnit() Resets the PhysicalSizeXUnit attribute to an unset state.
boolean	hasPhysicalSizeXUnit() Checks whether the optional PhysicalSizeXUnit attribute is present.
void	setPhysicalSizeY(PositiveFloat_Type value, boolean validate) Sets the value of the PhysicalSizeY attribute.
void	setPhysicalSizeY(PositiveFloat_Type value) Sets the value of the PhysicalSizeY attribute.
PositiveFloat_Type	getPhysicalSizeY() Returns the value of the PhysicalSizeY attribute.
void	resetPhysicalSizeY() Resets the PhysicalSizeY attribute to an unset state.
boolean	hasPhysicalSizeY() Checks whether the optional PhysicalSizeY attribute is present.
void	setPhysicalSizeYUnit(UnitsLength_Type value, boolean validate) Sets the value of the PhysicalSizeYUnit attribute.
void	setPhysicalSizeYUnit(UnitsLength_Type value) Sets the value of the PhysicalSizeYUnit attribute.
UnitsLength_Type	getPhysicalSizeYUnit() Returns the value of the PhysicalSizeYUnit attribute.
void	resetPhysicalSizeYUnit() Resets the PhysicalSizeYUnit attribute to an unset state.
boolean	hasPhysicalSizeYUnit() Checks whether the optional PhysicalSizeYUnit attribute is present.
void	setPhysicalSizeZ(PositiveFloat_Type value, boolean validate) Sets the value of the PhysicalSizeZ attribute.
void	setPhysicalSizeZ(PositiveFloat_Type value) Sets the value of the PhysicalSizeZ attribute.
PositiveFloat_Type	getPhysicalSizeZ() Returns the value of the PhysicalSizeZ attribute.
void	resetPhysicalSizeZ() Resets the PhysicalSizeZ attribute to an unset state.
boolean	hasPhysicalSizeZ() Checks whether the optional PhysicalSizeZ attribute is present.
void	setPhysicalSizeZUnit(UnitsLength_Type value, boolean validate) Sets the value of the PhysicalSizeZUnit attribute.
void	setPhysicalSizeZUnit(UnitsLength_Type value) Sets the value of the PhysicalSizeZUnit attribute.
UnitsLength_Type	getPhysicalSizeZUnit() Returns the value of the PhysicalSizeZUnit attribute.
void	resetPhysicalSizeZUnit() Resets the PhysicalSizeZUnit attribute to an unset state.
boolean	hasPhysicalSizeZUnit() Checks whether the optional PhysicalSizeZUnit attribute is present.
void	setTimeIncrement(PositiveFloat_Type value, boolean validate) Sets the value of the TimeIncrement attribute.
void	setTimeIncrement(PositiveFloat_Type value) Sets the value of the TimeIncrement attribute.
PositiveFloat_Type	getTimeIncrement() Returns the value of the TimeIncrement attribute.
void	resetTimeIncrement() Resets the TimeIncrement attribute to an unset state.
boolean	hasTimeIncrement() Checks whether the optional TimeIncrement attribute is present.
void	setTimeIncrementUnit(UnitsTime_Type value, boolean validate) Sets the value of the TimeIncrementUnit attribute.
void	setTimeIncrementUnit(UnitsTime_Type value) Sets the value of the TimeIncrementUnit attribute.
UnitsTime_Type	getTimeIncrementUnit() Returns the value of the TimeIncrementUnit attribute.
void	resetTimeIncrementUnit() Resets the TimeIncrementUnit attribute to an unset state.
boolean	hasTimeIncrementUnit() Checks whether the optional TimeIncrementUnit attribute is present.
void	setPixelType(PixelType_Type value, boolean validate) Sets the value of the PixelType attribute.
void	setPixelType(PixelType_Type value) Sets the value of the PixelType attribute.
PixelType_Type	getPixelType() Returns the value of the PixelType attribute.
void	resetPixelType() Resets the PixelType attribute to an unset state.
boolean	hasPixelType() Checks whether the optional PixelType attribute is present.
void	setInterleaved(boolean value, boolean validate) Sets the value of the Interleaved attribute.
void	setInterleaved(boolean value) Sets the value of the Interleaved attribute.
boolean	getInterleaved() Returns the value of the Interleaved attribute.
void	resetInterleaved() Resets the Interleaved attribute to an unset state.
boolean	hasInterleaved() Checks whether the Interleaved attribute is present.
void	setSignificantBits(PositiveInt_Type value, boolean validate) Sets the value of the SignificantBits attribute.
void	setSignificantBits(PositiveInt_Type value) Sets the value of the SignificantBits attribute.
PositiveInt_Type	getSignificantBits() Returns the value of the SignificantBits attribute.
void	resetSignificantBits() Resets the SignificantBits attribute to an unset state.
boolean	hasSignificantBits() Checks whether the optional SignificantBits attribute is present.
void	setBigEndian(boolean value, boolean validate) Sets the value of the BigEndian attribute.
void	setBigEndian(boolean value) Sets the value of the BigEndian attribute.
boolean	getBigEndian() Returns the value of the BigEndian attribute.
void	resetBigEndian() Resets the BigEndian attribute to an unset state.
boolean	hasBigEndian() Checks whether the BigEndian attribute is present.
void	setPlane_List(PlaneVector value, boolean validate) Sets the list of Plane elements.
void	setPlane_List(PlaneVector value) Sets the list of Plane elements.
PlaneVector	getPlane_List() Returns the list of Plane elements.
void	addToPlane_List(Plane value, boolean validate) Adds a new Plane element to this object.
void	addToPlane_List(Plane value) Adds a new Plane element to this object.
void	clearPlane_List() Clear the list of Plane.
void	setChannel_List(ChannelVector value, boolean validate) Sets the list of Channel elements.
void	setChannel_List(ChannelVector value) Sets the list of Channel elements.
ChannelVector	getChannel_List() Returns the list of Channel elements.
void	addToChannel_List(Channel value, boolean validate) Adds a new Channel element to this object.
void	addToChannel_List(Channel value) Adds a new Channel element to this object.
void	clearChannel_List() Clear the list of Channel.
void	setAdditionalDimensionMap(AdditionalDimensionMap value, boolean validate) Sets the value of the AdditionalDimensionMap element.
void	setAdditionalDimensionMap(AdditionalDimensionMap value) Sets the value of the AdditionalDimensionMap element.
AdditionalDimensionMap	getAdditionalDimensionMap() Returns the value of the AdditionalDimensionMap element.
void	resetAdditionalDimensionMap() Resets the AdditionalDimensionMap element to an unset state.
boolean	hasAdditionalDimensionMap() Checks whether the optional AdditionalDimensionMap element is present.
void	setpixels_choice(Pixels_Choice value, boolean validate) Sets the value of the pixels_choice element.
void	setpixels_choice(Pixels_Choice value) Sets the value of the pixels_choice element.
Pixels_Choice	getpixels_choice() Returns the value of the pixels_choice element.
void	resetpixels_choice() Resets the pixels_choice element to an unset state.
boolean	haspixels_choice() Checks whether the optional pixels_choice element is present.
Pixels	__internal_create(long cPtr, boolean own)
Pixels	fromBase(NBOBaseClass base) Cast a NBOBaseClass to a CMOS.

Protected Functions¶

	Name
	Pixels(long cPtr, boolean cMemoryOwn)
void	swigSetCMemOwn(boolean own)
void	finalize()
long	getCPtr(Pixels obj)

Additional inherited members¶

Protected Functions inherited from com.inscoper.nbo.NBOBaseClass

	Name
	NBOBaseClass(long cPtr, boolean cMemoryOwn)

Detailed Description¶

public class com.inscoper.nbo.Pixels;

Represents the XML element Pixels.

The Pixels element is going to be removed in the future, but it is still required. This is just notice that the contents of Pixels will be moved up to Image in a future release. This is because there has only been 1 Pixels object in each Image for some time. The concept of multiple Pixels sets for one Image failed to take off. It is therefore redundant. The Image will be unreadable if any of the required Pixel attributes are missing. The Pixels themselves can be stored within the OME-XML compressed by Plane, and encoded in Base64. Or the Pixels may be stored in TIFF format. The Pixels element should contain a list of BinData or TiffData, each containing a single Plane of pixels. These Pixels elements, when read in document order, must produce a 5-D Pixel array of the size specified in this element, and in the dimension order specified by 'DimensionOrder'. All of the values in the Pixels object when present should match the same value stored in any associated TIFF format (e.g. SizeX should be the same). Where there is a mismatch our readers will take the value from the TIFF structure as overriding the value in the OME-XML. This is simply a pragmatic decision as it increases the likelihood of reading data from a slightly incorrect file.

Public Functions Documentation¶

function delete¶

public synchronized void delete()

Reimplements: com.inscoper.nbo.NBOBaseClass.delete

function Pixels¶

public Pixels()

function getTypeName¶

public String getTypeName()

Returns the class type name.

Return: The class type name

Reimplements: com.inscoper.nbo.NBOBaseClass.getTypeName

function getXMLName¶

public String getXMLName()

Returns the XML element name corresponding to this class.

Return: The XML element name

Reimplements: com.inscoper.nbo.NBOBaseClass.getXMLName

function getNBOType¶

public ENBOType getNBOType()

Returns the NBO Type corresponding to this class.

Return: The NBO Type value

Reimplements: com.inscoper.nbo.NBOBaseClass.getNBOType

function getChildren¶

public NBOBaseClassVector getChildren()

Returns a list of all classes derived from this class.

Return: The list of derived classes

Reimplements: com.inscoper.nbo.NBOBaseClass.getChildren

function getSubElements¶

public NBOBaseClassVector getSubElements()

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

Return: The list of child classes

Reimplements: com.inscoper.nbo.NBOBaseClass.getSubElements

function fromJsonFile¶

public void fromJsonFile(
    String path,
    boolean validate
)

Populates this object from a JSON file.

Parameters:

path The path to the JSON file
validate If true, validates constraints on value. Default is true.

function fromJsonFile¶

public void fromJsonFile(
    String path
)

Populates this object from a JSON file.

Parameters:

path The path to the JSON file

function fromJsonString¶

public void fromJsonString(
    String json_string,
    boolean validate
)

Populates this object from a JSON string.

Parameters:

json_string The JSON content as a string
validate If true, validates constraints on value. Default is true.

function fromJsonString¶

public void fromJsonString(
    String json_string
)

Populates this object from a JSON string.

Parameters:

json_string The JSON content as a string

function fromXmlFile¶

public void fromXmlFile(
    String path,
    boolean validate
)

Populates this object from a XML file.

Parameters:

path The path to the XML file
validate If true, validates constraints on value. Default is true.

function fromXmlFile¶

public void fromXmlFile(
    String path
)

Populates this object from a XML file.

Parameters:

path The path to the XML file

function fromXmlString¶

public void fromXmlString(
    String xml_string,
    boolean validate
)

Populates this object from a XML string.

Parameters:

xml_string The XML content as a string
validate If true, validates constraints on value. Default is true.

function fromXmlString¶

public void fromXmlString(
    String xml_string
)

Populates this object from a XML string.

Parameters:

xml_string The XML content as a string

function toXmlFile¶

public void toXmlFile(
    String filename,
    boolean validate
)

Serializes this object to an XML file.

Parameters:

filename The path to the output XML file
validate If true, validates constraints on value. Default is true.

function toXmlFile¶

public void toXmlFile(
    String filename
)

Serializes this object to an XML file.

Parameters:

filename The path to the output XML file

function toXmlString¶

public String toXmlString(
    boolean validate
)

Serializes this object to an XML string.

Parameters:

validate If true, validates constraints on value. Default is true.

Return: A string containing the XML representation of this object

function toXmlString¶

public String toXmlString()

Serializes this object to an XML string.

Return: A string containing the XML representation of this object

function setID¶

public void setID(
    PixelsID_Type value,
    boolean validate
)

Sets the value of the ID attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

A Unique Identifier for this component.

function setID¶

public void setID(
    PixelsID_Type value
)

Sets the value of the ID attribute.

Parameters:

value The value to set

A Unique Identifier for this component.

function getID¶

public PixelsID_Type getID()

Returns the value of the ID attribute.

Return: The value of the attribute

A Unique Identifier for this component.

function resetID¶

public void resetID()

Resets the ID attribute to an unset state.

A Unique Identifier for this component.

function hasID¶

public boolean hasID()

Checks whether the optional ID attribute is present.

Return: true if the optional attribute has been set, false otherwise

A Unique Identifier for this component.

function setDimensionOrder¶

public void setDimensionOrder(
    PixelsDimensionOrder_Type value,
    boolean validate
)

Sets the value of the DimensionOrder attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

This field records the order in which the individual Planes of data are interleaved in the Image.

function setDimensionOrder¶

public void setDimensionOrder(
    PixelsDimensionOrder_Type value
)

Sets the value of the DimensionOrder attribute.

Parameters:

value The value to set

This field records the order in which the individual Planes of data are interleaved in the Image.

function getDimensionOrder¶

public PixelsDimensionOrder_Type getDimensionOrder()

Returns the value of the DimensionOrder attribute.

Return: The value of the attribute

This field records the order in which the individual Planes of data are interleaved in the Image.

function resetDimensionOrder¶

public void resetDimensionOrder()

Resets the DimensionOrder attribute to an unset state.

This field records the order in which the individual Planes of data are interleaved in the Image.

function hasDimensionOrder¶

public boolean hasDimensionOrder()

Checks whether the optional DimensionOrder attribute is present.

Return: true if the optional attribute has been set, false otherwise

This field records the order in which the individual Planes of data are interleaved in the Image.

function setSizeX¶

public void setSizeX(
    PositiveInt_Type value,
    boolean validate
)

Sets the value of the SizeX attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

This field records the X size of the Pixel data array.

function setSizeX¶

public void setSizeX(
    PositiveInt_Type value
)

Sets the value of the SizeX attribute.

Parameters:

value The value to set

This field records the X size of the Pixel data array.

function getSizeX¶

public PositiveInt_Type getSizeX()

Returns the value of the SizeX attribute.

Return: The value of the attribute

This field records the X size of the Pixel data array.

function resetSizeX¶

public void resetSizeX()

Resets the SizeX attribute to an unset state.

This field records the X size of the Pixel data array.

function hasSizeX¶

public boolean hasSizeX()

Checks whether the optional SizeX attribute is present.

Return: true if the optional attribute has been set, false otherwise

This field records the X size of the Pixel data array.

function setSizeY¶

public void setSizeY(
    PositiveInt_Type value,
    boolean validate
)

Sets the value of the SizeY attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

This field records the Y size of the Pixel data array.

function setSizeY¶

public void setSizeY(
    PositiveInt_Type value
)

Sets the value of the SizeY attribute.

Parameters:

value The value to set

This field records the Y size of the Pixel data array.

function getSizeY¶

public PositiveInt_Type getSizeY()

Returns the value of the SizeY attribute.

Return: The value of the attribute

This field records the Y size of the Pixel data array.

function resetSizeY¶

public void resetSizeY()

Resets the SizeY attribute to an unset state.

This field records the Y size of the Pixel data array.

function hasSizeY¶

public boolean hasSizeY()

Checks whether the optional SizeY attribute is present.

Return: true if the optional attribute has been set, false otherwise

This field records the Y size of the Pixel data array.

function setSizeZ¶

public void setSizeZ(
    PositiveInt_Type value,
    boolean validate
)

Sets the value of the SizeZ attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

This field records the number of Z-Planes acquired for this Image.

function setSizeZ¶

public void setSizeZ(
    PositiveInt_Type value
)

Sets the value of the SizeZ attribute.

Parameters:

value The value to set

This field records the number of Z-Planes acquired for this Image.

function getSizeZ¶

public PositiveInt_Type getSizeZ()

Returns the value of the SizeZ attribute.

Return: The value of the attribute

This field records the number of Z-Planes acquired for this Image.

function resetSizeZ¶

public void resetSizeZ()

Resets the SizeZ attribute to an unset state.

This field records the number of Z-Planes acquired for this Image.

function hasSizeZ¶

public boolean hasSizeZ()

Checks whether the optional SizeZ attribute is present.

Return: true if the optional attribute has been set, false otherwise

This field records the number of Z-Planes acquired for this Image.

function setSizeC¶

public void setSizeC(
    PositiveInt_Type value,
    boolean validate
)

Sets the value of the SizeC attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

This field records the number of Channels used in this Image

function setSizeC¶

public void setSizeC(
    PositiveInt_Type value
)

Sets the value of the SizeC attribute.

Parameters:

value The value to set

This field records the number of Channels used in this Image

function getSizeC¶

public PositiveInt_Type getSizeC()

Returns the value of the SizeC attribute.

Return: The value of the attribute

This field records the number of Channels used in this Image

function resetSizeC¶

public void resetSizeC()

Resets the SizeC attribute to an unset state.

This field records the number of Channels used in this Image

function hasSizeC¶

public boolean hasSizeC()

Checks whether the optional SizeC attribute is present.

Return: true if the optional attribute has been set, false otherwise

This field records the number of Channels used in this Image

function setSizeT¶

public void setSizeT(
    PositiveInt_Type value,
    boolean validate
)

Sets the value of the SizeT attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

This field records the number of Timepoints (often referred to as Frames) used in this Image.

function setSizeT¶

public void setSizeT(
    PositiveInt_Type value
)

Sets the value of the SizeT attribute.

Parameters:

value The value to set

This field records the number of Timepoints (often referred to as Frames) used in this Image.

function getSizeT¶

public PositiveInt_Type getSizeT()

Returns the value of the SizeT attribute.

Return: The value of the attribute

This field records the number of Timepoints (often referred to as Frames) used in this Image.

function resetSizeT¶

public void resetSizeT()

Resets the SizeT attribute to an unset state.

This field records the number of Timepoints (often referred to as Frames) used in this Image.

function hasSizeT¶

public boolean hasSizeT()

Checks whether the optional SizeT attribute is present.

Return: true if the optional attribute has been set, false otherwise

This field records the number of Timepoints (often referred to as Frames) used in this Image.

function setPhysicalSizeX¶

public void setPhysicalSizeX(
    PositiveFloat_Type value,
    boolean validate
)

Sets the value of the PhysicalSizeX attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

This field records the real world Physical Width represented by a Pixel in this Image. This measure is often referred to as X Pixel Size.

function setPhysicalSizeX¶

public void setPhysicalSizeX(
    PositiveFloat_Type value
)

Sets the value of the PhysicalSizeX attribute.

Parameters:

value The value to set

This field records the real world Physical Width represented by a Pixel in this Image. This measure is often referred to as X Pixel Size.

function getPhysicalSizeX¶

public PositiveFloat_Type getPhysicalSizeX()

Returns the value of the PhysicalSizeX attribute.

Return: The value of the attribute

This field records the real world Physical Width represented by a Pixel in this Image. This measure is often referred to as X Pixel Size.

function resetPhysicalSizeX¶

public void resetPhysicalSizeX()

Resets the PhysicalSizeX attribute to an unset state.

This field records the real world Physical Width represented by a Pixel in this Image. This measure is often referred to as X Pixel Size.

function hasPhysicalSizeX¶

public boolean hasPhysicalSizeX()

Checks whether the optional PhysicalSizeX attribute is present.

Return: true if the optional attribute has been set, false otherwise

This field records the real world Physical Width represented by a Pixel in this Image. This measure is often referred to as X Pixel Size.

function setPhysicalSizeXUnit¶

public void setPhysicalSizeXUnit(
    UnitsLength_Type value,
    boolean validate
)

Sets the value of the PhysicalSizeXUnit attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function setPhysicalSizeXUnit¶

public void setPhysicalSizeXUnit(
    UnitsLength_Type value
)

Sets the value of the PhysicalSizeXUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getPhysicalSizeXUnit¶

public UnitsLength_Type getPhysicalSizeXUnit()

Returns the value of the PhysicalSizeXUnit attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetPhysicalSizeXUnit¶

public void resetPhysicalSizeXUnit()

Resets the PhysicalSizeXUnit attribute to an unset state.

No description available in the XSD standard.

function hasPhysicalSizeXUnit¶

public boolean hasPhysicalSizeXUnit()

Checks whether the optional PhysicalSizeXUnit attribute is present.

Return: true if the optional attribute has been set, false otherwise

No description available in the XSD standard.

function setPhysicalSizeY¶

public void setPhysicalSizeY(
    PositiveFloat_Type value,
    boolean validate
)

Sets the value of the PhysicalSizeY attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

This field records the real world Physical Height represented by a Pixel in this Image. This measure is often referred to as Y Pixel Size.

function setPhysicalSizeY¶

public void setPhysicalSizeY(
    PositiveFloat_Type value
)

Sets the value of the PhysicalSizeY attribute.

Parameters:

value The value to set

This field records the real world Physical Height represented by a Pixel in this Image. This measure is often referred to as Y Pixel Size.

function getPhysicalSizeY¶

public PositiveFloat_Type getPhysicalSizeY()

Returns the value of the PhysicalSizeY attribute.

Return: The value of the attribute

This field records the real world Physical Height represented by a Pixel in this Image. This measure is often referred to as Y Pixel Size.

function resetPhysicalSizeY¶

public void resetPhysicalSizeY()

Resets the PhysicalSizeY attribute to an unset state.

This field records the real world Physical Height represented by a Pixel in this Image. This measure is often referred to as Y Pixel Size.

function hasPhysicalSizeY¶

public boolean hasPhysicalSizeY()

Checks whether the optional PhysicalSizeY attribute is present.

Return: true if the optional attribute has been set, false otherwise

This field records the real world Physical Height represented by a Pixel in this Image. This measure is often referred to as Y Pixel Size.

function setPhysicalSizeYUnit¶

public void setPhysicalSizeYUnit(
    UnitsLength_Type value,
    boolean validate
)

Sets the value of the PhysicalSizeYUnit attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function setPhysicalSizeYUnit¶

public void setPhysicalSizeYUnit(
    UnitsLength_Type value
)

Sets the value of the PhysicalSizeYUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getPhysicalSizeYUnit¶

public UnitsLength_Type getPhysicalSizeYUnit()

Returns the value of the PhysicalSizeYUnit attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetPhysicalSizeYUnit¶

public void resetPhysicalSizeYUnit()

Resets the PhysicalSizeYUnit attribute to an unset state.

No description available in the XSD standard.

function hasPhysicalSizeYUnit¶

public boolean hasPhysicalSizeYUnit()

Checks whether the optional PhysicalSizeYUnit attribute is present.

Return: true if the optional attribute has been set, false otherwise

No description available in the XSD standard.

function setPhysicalSizeZ¶

public void setPhysicalSizeZ(
    PositiveFloat_Type value,
    boolean validate
)

Sets the value of the PhysicalSizeZ attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

This field records the real world Physical distance between the individual Z-Planes recorded for this Image. This measure is sometimes referred to as Z Pixel or Voxel Size.

function setPhysicalSizeZ¶

public void setPhysicalSizeZ(
    PositiveFloat_Type value
)

Sets the value of the PhysicalSizeZ attribute.

Parameters:

value The value to set

This field records the real world Physical distance between the individual Z-Planes recorded for this Image. This measure is sometimes referred to as Z Pixel or Voxel Size.

function getPhysicalSizeZ¶

public PositiveFloat_Type getPhysicalSizeZ()

Returns the value of the PhysicalSizeZ attribute.

Return: The value of the attribute

This field records the real world Physical distance between the individual Z-Planes recorded for this Image. This measure is sometimes referred to as Z Pixel or Voxel Size.

function resetPhysicalSizeZ¶

public void resetPhysicalSizeZ()

Resets the PhysicalSizeZ attribute to an unset state.

This field records the real world Physical distance between the individual Z-Planes recorded for this Image. This measure is sometimes referred to as Z Pixel or Voxel Size.

function hasPhysicalSizeZ¶

public boolean hasPhysicalSizeZ()

Checks whether the optional PhysicalSizeZ attribute is present.

Return: true if the optional attribute has been set, false otherwise

This field records the real world Physical distance between the individual Z-Planes recorded for this Image. This measure is sometimes referred to as Z Pixel or Voxel Size.

function setPhysicalSizeZUnit¶

public void setPhysicalSizeZUnit(
    UnitsLength_Type value,
    boolean validate
)

Sets the value of the PhysicalSizeZUnit attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function setPhysicalSizeZUnit¶

public void setPhysicalSizeZUnit(
    UnitsLength_Type value
)

Sets the value of the PhysicalSizeZUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getPhysicalSizeZUnit¶

public UnitsLength_Type getPhysicalSizeZUnit()

Returns the value of the PhysicalSizeZUnit attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetPhysicalSizeZUnit¶

public void resetPhysicalSizeZUnit()

Resets the PhysicalSizeZUnit attribute to an unset state.

No description available in the XSD standard.

function hasPhysicalSizeZUnit¶

public boolean hasPhysicalSizeZUnit()

Checks whether the optional PhysicalSizeZUnit attribute is present.

Return: true if the optional attribute has been set, false otherwise

No description available in the XSD standard.

function setTimeIncrement¶

public void setTimeIncrement(
    PositiveFloat_Type value,
    boolean validate
)

Sets the value of the TimeIncrement attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

In cases in which a time series is acquired with a global timing specification setting, this field describes the time between each sequential plane (or frame) in the series (i.e., from the start of time point 1 to the start of time point 2). Examples include, a video stream or a multi-dimensional Acquisition routine. Note that, this field is not intended to substitute the Timestamp attribute recorded in Plane. Also note that in case this field is not relevant e.g. a time lapse Acquisition with irregular increments, the value -1 should be used to indicate that only the Timestamps (in the Plane element) are valid.

function setTimeIncrement¶

public void setTimeIncrement(
    PositiveFloat_Type value
)

Sets the value of the TimeIncrement attribute.

Parameters:

value The value to set

In cases in which a time series is acquired with a global timing specification setting, this field describes the time between each sequential plane (or frame) in the series (i.e., from the start of time point 1 to the start of time point 2). Examples include, a video stream or a multi-dimensional Acquisition routine. Note that, this field is not intended to substitute the Timestamp attribute recorded in Plane. Also note that in case this field is not relevant e.g. a time lapse Acquisition with irregular increments, the value -1 should be used to indicate that only the Timestamps (in the Plane element) are valid.

function getTimeIncrement¶

public PositiveFloat_Type getTimeIncrement()

Returns the value of the TimeIncrement attribute.

Return: The value of the attribute

In cases in which a time series is acquired with a global timing specification setting, this field describes the time between each sequential plane (or frame) in the series (i.e., from the start of time point 1 to the start of time point 2). Examples include, a video stream or a multi-dimensional Acquisition routine. Note that, this field is not intended to substitute the Timestamp attribute recorded in Plane. Also note that in case this field is not relevant e.g. a time lapse Acquisition with irregular increments, the value -1 should be used to indicate that only the Timestamps (in the Plane element) are valid.

function resetTimeIncrement¶

public void resetTimeIncrement()

Resets the TimeIncrement attribute to an unset state.

In cases in which a time series is acquired with a global timing specification setting, this field describes the time between each sequential plane (or frame) in the series (i.e., from the start of time point 1 to the start of time point 2). Examples include, a video stream or a multi-dimensional Acquisition routine. Note that, this field is not intended to substitute the Timestamp attribute recorded in Plane. Also note that in case this field is not relevant e.g. a time lapse Acquisition with irregular increments, the value -1 should be used to indicate that only the Timestamps (in the Plane element) are valid.

function hasTimeIncrement¶

public boolean hasTimeIncrement()

Checks whether the optional TimeIncrement attribute is present.

Return: true if the optional attribute has been set, false otherwise

In cases in which a time series is acquired with a global timing specification setting, this field describes the time between each sequential plane (or frame) in the series (i.e., from the start of time point 1 to the start of time point 2). Examples include, a video stream or a multi-dimensional Acquisition routine. Note that, this field is not intended to substitute the Timestamp attribute recorded in Plane. Also note that in case this field is not relevant e.g. a time lapse Acquisition with irregular increments, the value -1 should be used to indicate that only the Timestamps (in the Plane element) are valid.

function setTimeIncrementUnit¶

public void setTimeIncrementUnit(
    UnitsTime_Type value,
    boolean validate
)

Sets the value of the TimeIncrementUnit attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function setTimeIncrementUnit¶

public void setTimeIncrementUnit(
    UnitsTime_Type value
)

Sets the value of the TimeIncrementUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getTimeIncrementUnit¶

public UnitsTime_Type getTimeIncrementUnit()

Returns the value of the TimeIncrementUnit attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetTimeIncrementUnit¶

public void resetTimeIncrementUnit()

Resets the TimeIncrementUnit attribute to an unset state.

No description available in the XSD standard.

function hasTimeIncrementUnit¶

public boolean hasTimeIncrementUnit()

Checks whether the optional TimeIncrementUnit attribute is present.

Return: true if the optional attribute has been set, false otherwise

No description available in the XSD standard.

function setPixelType¶

public void setPixelType(
    PixelType_Type value,
    boolean validate
)

Sets the value of the PixelType attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

This field records the data type used to represent the Pixel Intensity in the Image.

function setPixelType¶

public void setPixelType(
    PixelType_Type value
)

Sets the value of the PixelType attribute.

Parameters:

value The value to set

This field records the data type used to represent the Pixel Intensity in the Image.

function getPixelType¶

public PixelType_Type getPixelType()

Returns the value of the PixelType attribute.

Return: The value of the attribute

This field records the data type used to represent the Pixel Intensity in the Image.

function resetPixelType¶

public void resetPixelType()

Resets the PixelType attribute to an unset state.

This field records the data type used to represent the Pixel Intensity in the Image.

function hasPixelType¶

public boolean hasPixelType()

Checks whether the optional PixelType attribute is present.

Return: true if the optional attribute has been set, false otherwise

This field records the data type used to represent the Pixel Intensity in the Image.

function setInterleaved¶

public void setInterleaved(
    boolean value,
    boolean validate
)

Sets the value of the Interleaved attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

This field records the order in which the Channels are arranged within the data block: True if Channels are stored RGBRGBRGB...; False if Channels are stored RRR...GGG...BBB…

function setInterleaved¶

public void setInterleaved(
    boolean value
)

Sets the value of the Interleaved attribute.

Parameters:

value The value to set

This field records the order in which the Channels are arranged within the data block: True if Channels are stored RGBRGBRGB...; False if Channels are stored RRR...GGG...BBB…

function getInterleaved¶

public boolean getInterleaved()

Returns the value of the Interleaved attribute.

Return: The value of the attribute

This field records the order in which the Channels are arranged within the data block: True if Channels are stored RGBRGBRGB...; False if Channels are stored RRR...GGG...BBB…

function resetInterleaved¶

public void resetInterleaved()

Resets the Interleaved attribute to an unset state.

This field records the order in which the Channels are arranged within the data block: True if Channels are stored RGBRGBRGB...; False if Channels are stored RRR...GGG...BBB…

function hasInterleaved¶

public boolean hasInterleaved()

Checks whether the Interleaved attribute is present.

Return: true if the attribute has been set, false otherwise

This field records the order in which the Channels are arranged within the data block: True if Channels are stored RGBRGBRGB...; False if Channels are stored RRR...GGG...BBB…

function setSignificantBits¶

public void setSignificantBits(
    PositiveInt_Type value,
    boolean validate
)

Sets the value of the SignificantBits attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

This field records the number of bits within the type storing each Pixel value that are significant. e.g.,. you can store 12-bit data within a 16-bit type. This does not reduce the storage requirements but can be a useful indicator when processing or viewing the Image data.

function setSignificantBits¶

public void setSignificantBits(
    PositiveInt_Type value
)

Sets the value of the SignificantBits attribute.

Parameters:

value The value to set

This field records the number of bits within the type storing each Pixel value that are significant. e.g.,. you can store 12-bit data within a 16-bit type. This does not reduce the storage requirements but can be a useful indicator when processing or viewing the Image data.

function getSignificantBits¶

public PositiveInt_Type getSignificantBits()

Returns the value of the SignificantBits attribute.

Return: The value of the attribute

This field records the number of bits within the type storing each Pixel value that are significant. e.g.,. you can store 12-bit data within a 16-bit type. This does not reduce the storage requirements but can be a useful indicator when processing or viewing the Image data.

function resetSignificantBits¶

public void resetSignificantBits()

Resets the SignificantBits attribute to an unset state.

This field records the number of bits within the type storing each Pixel value that are significant. e.g.,. you can store 12-bit data within a 16-bit type. This does not reduce the storage requirements but can be a useful indicator when processing or viewing the Image data.

function hasSignificantBits¶

public boolean hasSignificantBits()

Checks whether the optional SignificantBits attribute is present.

Return: true if the optional attribute has been set, false otherwise

This field records the number of bits within the type storing each Pixel value that are significant. e.g.,. you can store 12-bit data within a 16-bit type. This does not reduce the storage requirements but can be a useful indicator when processing or viewing the Image data.

function setBigEndian¶

public void setBigEndian(
    boolean value,
    boolean validate
)

Sets the value of the BigEndian attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

This field is True if the pixels data was written in BigEndian order. If this value is present, it should match the value used in BinData or TiffData. If it is not, a reader should be used that honors the value used in the BinData or TiffData. This value is useful for MetadataOnly files and is to allow for future storage solutions.

function setBigEndian¶

public void setBigEndian(
    boolean value
)

Sets the value of the BigEndian attribute.

Parameters:

value The value to set

This field is True if the pixels data was written in BigEndian order. If this value is present, it should match the value used in BinData or TiffData. If it is not, a reader should be used that honors the value used in the BinData or TiffData. This value is useful for MetadataOnly files and is to allow for future storage solutions.

function getBigEndian¶

public boolean getBigEndian()

Returns the value of the BigEndian attribute.

Return: The value of the attribute

This field is True if the pixels data was written in BigEndian order. If this value is present, it should match the value used in BinData or TiffData. If it is not, a reader should be used that honors the value used in the BinData or TiffData. This value is useful for MetadataOnly files and is to allow for future storage solutions.

function resetBigEndian¶

public void resetBigEndian()

Resets the BigEndian attribute to an unset state.

This field is True if the pixels data was written in BigEndian order. If this value is present, it should match the value used in BinData or TiffData. If it is not, a reader should be used that honors the value used in the BinData or TiffData. This value is useful for MetadataOnly files and is to allow for future storage solutions.

function hasBigEndian¶

public boolean hasBigEndian()

Checks whether the BigEndian attribute is present.

Return: true if the attribute has been set, false otherwise

This field is True if the pixels data was written in BigEndian order. If this value is present, it should match the value used in BinData or TiffData. If it is not, a reader should be used that honors the value used in the BinData or TiffData. This value is useful for MetadataOnly files and is to allow for future storage solutions.

function setPlane_List¶

public void setPlane_List(
    PlaneVector value,
    boolean validate
)

Sets the list of Plane elements.

Parameters:

value The new list of Plane elements
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function setPlane_List¶

public void setPlane_List(
    PlaneVector value
)

Sets the list of Plane elements.

Parameters:

value The new list of Plane elements

No description available in the XSD standard.

function getPlane_List¶

public PlaneVector getPlane_List()

Returns the list of Plane elements.

Return: The list of Plane elements

No description available in the XSD standard.

function addToPlane_List¶

public void addToPlane_List(
    Plane value,
    boolean validate
)

Adds a new Plane element to this object.

Parameters:

value The element to add
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function addToPlane_List¶

public void addToPlane_List(
    Plane value
)

Adds a new Plane element to this object.

Parameters:

value The element to add

No description available in the XSD standard.

function clearPlane_List¶

public void clearPlane_List()

Clear the list of Plane.

No description available in the XSD standard.

function setChannel_List¶

public void setChannel_List(
    ChannelVector value,
    boolean validate
)

Sets the list of Channel elements.

Parameters:

value The new list of Channel elements
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function setChannel_List¶

public void setChannel_List(
    ChannelVector value
)

Sets the list of Channel elements.

Parameters:

value The new list of Channel elements

No description available in the XSD standard.

function getChannel_List¶

public ChannelVector getChannel_List()

Returns the list of Channel elements.

Return: The list of Channel elements

No description available in the XSD standard.

function addToChannel_List¶

public void addToChannel_List(
    Channel value,
    boolean validate
)

Adds a new Channel element to this object.

Parameters:

value The element to add
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function addToChannel_List¶

public void addToChannel_List(
    Channel value
)

Adds a new Channel element to this object.

Parameters:

value The element to add

No description available in the XSD standard.

function clearChannel_List¶

public void clearChannel_List()

Clear the list of Channel.

No description available in the XSD standard.

function setAdditionalDimensionMap¶

public void setAdditionalDimensionMap(
    AdditionalDimensionMap value,
    boolean validate
)

Sets the value of the AdditionalDimensionMap element.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function setAdditionalDimensionMap¶

public void setAdditionalDimensionMap(
    AdditionalDimensionMap value
)

Sets the value of the AdditionalDimensionMap element.

Parameters:

value The value to set

No description available in the XSD standard.

function getAdditionalDimensionMap¶

public AdditionalDimensionMap getAdditionalDimensionMap()

Returns the value of the AdditionalDimensionMap element.

Return: The value of the element

No description available in the XSD standard.

function resetAdditionalDimensionMap¶

public void resetAdditionalDimensionMap()

Resets the AdditionalDimensionMap element to an unset state.

No description available in the XSD standard.

function hasAdditionalDimensionMap¶

public boolean hasAdditionalDimensionMap()

Checks whether the optional AdditionalDimensionMap element is present.

Return: true if the optional attribute has been set, false otherwise

No description available in the XSD standard.

function setpixels_choice¶

public void setpixels_choice(
    Pixels_Choice value,
    boolean validate
)

Sets the value of the pixels_choice element.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function setpixels_choice¶

public void setpixels_choice(
    Pixels_Choice value
)

Sets the value of the pixels_choice element.

Parameters:

value The value to set

No description available in the XSD standard.

function getpixels_choice¶

public Pixels_Choice getpixels_choice()

Returns the value of the pixels_choice element.

Return: The value of the element

No description available in the XSD standard.

function resetpixels_choice¶

public void resetpixels_choice()

Resets the pixels_choice element to an unset state.

No description available in the XSD standard.

function haspixels_choice¶

public boolean haspixels_choice()

Checks whether the optional pixels_choice element is present.

Return: true if the optional attribute has been set, false otherwise

No description available in the XSD standard.

function __internal_create¶

public static Pixels __internal_create(
    long cPtr,
    boolean own
)

Reimplements: com.inscoper.nbo.NBOBaseClass.__internal_create

function fromBase¶

public static Pixels fromBase(
    NBOBaseClass base
)

Cast a NBOBaseClass to a CMOS.

Parameters:

base The base class to cast

Return: The casted element, or nullptr if the cast fails

Protected Functions Documentation¶

function Pixels¶

protected Pixels(
    long cPtr,
    boolean cMemoryOwn
)

function swigSetCMemOwn¶

protected void swigSetCMemOwn(
    boolean own
)

Reimplements: com.inscoper.nbo.NBOBaseClass.swigSetCMemOwn

function finalize¶

protected void finalize()

Reimplements: com.inscoper.nbo.NBOBaseClass.finalize

function getCPtr¶

protected static long getCPtr(
    Pixels obj
)

Updated on 2026-06-22 at 17:06:32 +0200