loci.formats.in

Class ND2Handler

java.lang.Object

org.xml.sax.helpers.DefaultHandler

loci.common.xml.BaseHandler

loci.formats.in.ND2Handler

All Implemented Interfaces:

org.xml.sax.ContentHandler, org.xml.sax.DTDHandler, org.xml.sax.EntityResolver, org.xml.sax.ErrorHandler

public class ND2Handler
extends BaseHandler

DefaultHandler implementation for handling XML produced by Nikon Elements.

Source code:

Trac, Gitweb

Constructor Summary

Constructors

Constructor and Description
ND2Handler(java.util.List<CoreMetadata> core, boolean populateXY, int nImages)
ND2Handler(java.util.List<CoreMetadata> core, int nImages)

Method Summary

Methods

Modifier and Type	Method and Description
void	endDocument()
void	endElement(java.lang.String uri, java.lang.String localName, java.lang.String qName, org.xml.sax.Attributes attributes)
java.util.ArrayList<java.lang.String>	getBinnings()
java.lang.String	getCameraModel()
java.util.Hashtable<java.lang.String,java.lang.Integer>	getChannelColors()
java.util.ArrayList<java.lang.String>	getChannelNames()
java.util.List<CoreMetadata>	getCoreMetadataList()
java.lang.String	getCorrection()
java.lang.String	getDate()
java.util.ArrayList<java.lang.Integer>	getEmissionWavelengths()
java.util.ArrayList<java.lang.Integer>	getExcitationWavelengths()
java.util.ArrayList<java.lang.Double>	getExposureTimes()
int	getFieldIndex()
java.util.ArrayList<java.lang.Double>	getGains()
java.lang.String	getImmersion()
java.lang.Double	getMagnification()
java.util.Hashtable<java.lang.String,java.lang.Object>	getMetadata()
java.util.ArrayList<java.lang.String>	getModalities()
java.lang.Double	getNumericalAperture()
java.lang.String	getObjectiveModel()
java.lang.Double	getPinholeSize()
double	getPixelSizeX()
double	getPixelSizeY()
double	getPixelSizeZ()
java.util.ArrayList<java.lang.String>	getPositionNames()
java.util.ArrayList<java.lang.Integer>	getPowers()
java.lang.Double	getRefractiveIndex()
java.util.ArrayList<java.util.Hashtable<java.lang.String,java.lang.String>>	getROIs()
int	getSeriesCount()
java.util.ArrayList<java.lang.Double>	getSpeeds()
java.util.ArrayList<java.lang.Double>	getTemperatures()
java.util.ArrayList<java.lang.Long>	getTimepoints()
java.lang.Double	getVoltage()
int	getXFields()
java.util.ArrayList<java.lang.Double>	getXPositions()
java.util.ArrayList<java.lang.Double>	getYPositions()
java.util.ArrayList<java.lang.Double>	getZPositions()
java.util.ArrayList<java.lang.Long>	getZSections()
boolean	isDimensions(java.lang.String key) Returns whether or not the specified key is denotes dimensions.
boolean	isLossless()
void	parseKeyAndValue(java.lang.String key, java.lang.String value, java.lang.String runtype)
void	populateROIs(MetadataStore store)
void	startElement(java.lang.String uri, java.lang.String localName, java.lang.String qName, org.xml.sax.Attributes attributes)

Methods inherited from class loci.common.xml.BaseHandler

resolveEntity

Methods inherited from class org.xml.sax.helpers.DefaultHandler

characters, endElement, endPrefixMapping, error, fatalError, ignorableWhitespace, notationDecl, processingInstruction, setDocumentLocator, skippedEntity, startDocument, startPrefixMapping, unparsedEntityDecl, warning

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ND2Handler

public ND2Handler(java.util.List<CoreMetadata> core,
          int nImages)

ND2Handler

public ND2Handler(java.util.List<CoreMetadata> core,
          boolean populateXY,
          int nImages)

Method Detail

getXFields

public int getXFields()

getCoreMetadataList

public java.util.List<CoreMetadata> getCoreMetadataList()

populateROIs

public void populateROIs(MetadataStore store)

getDate

public java.lang.String getDate()

getMetadata

public java.util.Hashtable<java.lang.String,java.lang.Object> getMetadata()

getSeriesCount

public int getSeriesCount()

isLossless

public boolean isLossless()

getZSections

public java.util.ArrayList<java.lang.Long> getZSections()

getTimepoints

public java.util.ArrayList<java.lang.Long> getTimepoints()

getPixelSizeX

public double getPixelSizeX()

getPixelSizeY

public double getPixelSizeY()

getPixelSizeZ

public double getPixelSizeZ()

getPinholeSize

public java.lang.Double getPinholeSize()

getVoltage

public java.lang.Double getVoltage()

getMagnification

public java.lang.Double getMagnification()

getNumericalAperture

public java.lang.Double getNumericalAperture()

getObjectiveModel

public java.lang.String getObjectiveModel()

getImmersion

public java.lang.String getImmersion()

getCorrection

public java.lang.String getCorrection()

getRefractiveIndex

public java.lang.Double getRefractiveIndex()

getChannelNames

public java.util.ArrayList<java.lang.String> getChannelNames()

getModalities

public java.util.ArrayList<java.lang.String> getModalities()

getBinnings

public java.util.ArrayList<java.lang.String> getBinnings()

getSpeeds

public java.util.ArrayList<java.lang.Double> getSpeeds()

getGains

public java.util.ArrayList<java.lang.Double> getGains()

getTemperatures

public java.util.ArrayList<java.lang.Double> getTemperatures()

getExposureTimes

public java.util.ArrayList<java.lang.Double> getExposureTimes()

getExcitationWavelengths

public java.util.ArrayList<java.lang.Integer> getExcitationWavelengths()

getEmissionWavelengths

public java.util.ArrayList<java.lang.Integer> getEmissionWavelengths()

getPowers

public java.util.ArrayList<java.lang.Integer> getPowers()

getROIs

public java.util.ArrayList<java.util.Hashtable<java.lang.String,java.lang.String>> getROIs()

getXPositions

public java.util.ArrayList<java.lang.Double> getXPositions()

getYPositions

public java.util.ArrayList<java.lang.Double> getYPositions()

getZPositions

public java.util.ArrayList<java.lang.Double> getZPositions()

getPositionNames

public java.util.ArrayList<java.lang.String> getPositionNames()

getCameraModel

public java.lang.String getCameraModel()

getFieldIndex

public int getFieldIndex()

getChannelColors

public java.util.Hashtable<java.lang.String,java.lang.Integer> getChannelColors()

endElement

public void endElement(java.lang.String uri,
              java.lang.String localName,
              java.lang.String qName,
              org.xml.sax.Attributes attributes)

startElement

public void startElement(java.lang.String uri,
                java.lang.String localName,
                java.lang.String qName,
                org.xml.sax.Attributes attributes)

Specified by:

startElement in interface org.xml.sax.ContentHandler

Overrides:

startElement in class org.xml.sax.helpers.DefaultHandler

endDocument

public void endDocument()

Specified by:

endDocument in interface org.xml.sax.ContentHandler

Overrides:

endDocument in class org.xml.sax.helpers.DefaultHandler

parseKeyAndValue

public void parseKeyAndValue(java.lang.String key,
                    java.lang.String value,
                    java.lang.String runtype)

isDimensions

public boolean isDimensions(java.lang.String key)

Returns whether or not the specified key is denotes dimensions. Full versions of Elements allow the user to choose a language, though it's not clear what all of the choices are. Most keys are always recorded in English, but some are recorded in the language specified by the user.