Package org.anchoranalysis.mpp.feature.bean.mark

Class FeatureInputMark

Object

FeatureInputMark

All Implemented Interfaces:

FeatureInput, FeatureInputDictionary, FeatureInputWithResolution

public class FeatureInputMark
extends Object
implements FeatureInputDictionary

A feature input that wraps a Mark along with optional dimensions and dictionary.

This class implements FeatureInputDictionary to provide dictionary-related functionality for feature calculations on marks.

Constructor Summary

Constructors

Constructor	Description
FeatureInputMark(Mark mark, Optional<Dimensions> dimensions)	Constructs a new instance with a mark and optional dimensions.
FeatureInputMark(Mark mark, Optional<Dimensions> dimensions, Optional<Dictionary> dictionary)	Creates a new FeatureInputMark instance.
FeatureInputMark(Mark mark, Dimensions dimensions, Dictionary dictionary)	Constructs a new instance with a mark, dimensions, and dictionary.

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
Optional<Dictionary>	getDictionaryOptional()	The associated dictionary, if it exists.
Optional<Dimensions>	getDimensionsOptional()	Gets the optional dimensions associated with this feature input.
Dimensions	getDimensionsRequired()	Gets the dimensions associated with this feature input, throwing an exception if not present.
Mark	getMark()	The mark associated with this feature input.
Optional<Resolution>	getResolutionOptional()	The resolution of the associated image, if it is available.
int	hashCode()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.anchoranalysis.feature.input.FeatureInputDictionary

getDictionaryRequired

Methods inherited from interface org.anchoranalysis.feature.input.FeatureInputWithResolution

getResolutionRequired

Constructor Details

FeatureInputMark

public FeatureInputMark(Mark mark,
 Optional<Dimensions> dimensions)

Constructs a new instance with a mark and optional dimensions.

Parameters:

mark - the mark

dimensions - optional dimensions

FeatureInputMark

public FeatureInputMark(Mark mark,
 Dimensions dimensions,
 Dictionary dictionary)

Constructs a new instance with a mark, dimensions, and dictionary.

Parameters:

mark - the mark

dimensions - the dimensions

dictionary - the dictionary

FeatureInputMark

public FeatureInputMark(Mark mark,
 Optional<Dimensions> dimensions,
 Optional<Dictionary> dictionary)

Creates a new FeatureInputMark instance.

Parameters:

mark - The mark associated with this feature input.

dimensions - Optional dimensions associated with the mark.

dictionary - Optional dictionary associated with the mark.

Method Details

getResolutionOptional

public Optional<Resolution> getResolutionOptional()

Description copied from interface: FeatureInputWithResolution

The resolution of the associated image, if it is available.

Specified by:

getResolutionOptional in interface FeatureInputWithResolution

Returns:

the resolution, if it is available.

getDictionaryOptional

public Optional<Dictionary> getDictionaryOptional()

Description copied from interface: FeatureInputDictionary

The associated dictionary, if it exists.

Specified by:

getDictionaryOptional in interface FeatureInputDictionary

Returns:

the dictionary, if it exists.

getDimensionsOptional

public Optional<Dimensions> getDimensionsOptional()

Gets the optional dimensions associated with this feature input.

Returns:

an Optional containing the dimensions, if present

getDimensionsRequired

public Dimensions getDimensionsRequired()
                                 throws FeatureCalculationException

Gets the dimensions associated with this feature input, throwing an exception if not present.

Returns:

the dimensions

Throws:

FeatureCalculationException - if dimensions are not present

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getMark

public Mark getMark()

The mark associated with this feature input.