Package org.anchoranalysis.plugin.image.feature.bean.metadata

Class ExtractTime

Object

AnchorBean<Feature<FeatureInputImageMetadata>>

InitializableBean<Feature<FeatureInputImageMetadata>,FeatureInitialization>

Feature<FeatureInputImageMetadata>

FeatureImageMetadata

ExtractTime

Direct Known Subclasses:

AcquisitionTime, CreationTime, ModificationTime

public abstract class ExtractTime
extends FeatureImageMetadata

Base class for extracting time information from an image's metadata.

It is specified as the number of seconds from the epoch of 1970-01-01T00:00:00Z.

If the time is not specified, this feature will return NaN.

Constructor Summary

Constructors

Constructor	Description
ExtractTime()

Method Summary

Modifier and Type	Method	Description
double	calculate(ImageMetadata metadata)	Calculates the feature-value for a given ImageMetadata.
protected abstract Optional<ZonedDateTime>	extractTime(ImageMetadata metadata)	Extracts the time from the given metadata to return as the feature-value (if non-empty).

Methods inherited from class org.anchoranalysis.image.feature.bean.FeatureImageMetadata

calculate, inputType

Methods inherited from class org.anchoranalysis.feature.bean.Feature

assignTo, beforeCalc, calculateCheckInitialized, castAs, createListChildFeatures, describeBean, describeParameters, descriptionLong, duplicateChangeName, getCustomName, getFriendlyName, onInitialization, setCustomName, toString

Methods inherited from class org.anchoranalysis.bean.initializable.InitializableBean

getInitialization, getLogger, getPropertyInitializer, initialize, initializeRecursive, initRecursiveWithInitializer, isInitialized

Methods inherited from class org.anchoranalysis.bean.AnchorBean

checkMisconfigured, describeChildren, duplicateBean, fields, findFieldsOfClass, getBeanName, getLocalPath, localise

Methods inherited from class java.lang.Object

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

Constructor Details

ExtractTime

public ExtractTime()

Method Details

calculate

public double calculate(ImageMetadata metadata)
                 throws FeatureCalculationException

Description copied from class: FeatureImageMetadata

Calculates the feature-value for a given ImageMetadata.

Specified by:

calculate in class FeatureImageMetadata

Parameters:

metadata - the metadata.

Returns:

the calculated feature-value.

Throws:

FeatureCalculationException - if the feature-value cannot be calculated.

extractTime

protected abstract Optional<ZonedDateTime> extractTime(ImageMetadata metadata)

Extracts the time from the given metadata to return as the feature-value (if non-empty).

Parameters:

metadata - to extract a time from.

Returns:

the time, or empty if it's not specified