adams.data.imagej.flattener
Class Histogram

java.lang.Object
  adams.core.ConsoleObject
      adams.core.option.AbstractOptionHandler
          adams.data.image.AbstractImageFlattener<ImagePlusContainer>
              adams.data.imagej.flattener.AbstractImageJFlattener
                  adams.data.imagej.flattener.Histogram

All Implemented Interfaces:

CleanUpHandler, Debuggable, Destroyable, OptionHandler, SizeOfHandler, Serializable, Comparable

public class Histogram
extends AbstractImageJFlattener

Turns an image into a histogram.
In case of an 8-bit histogram, the image must already be converted to a gray image.

Valid options are:

-D <int> (property: debugLevel)
    The greater the number the more additional info the scheme may output to 
    the console (0 = off).
    default: 0
    minimum: 0
 

-field <adams.data.report.Field> [-field ...] (property: fields)
    The fields to add to the output.
    default: 
 

-notes <adams.core.base.BaseString> [-notes ...] (property: notes)
    The notes to add as attributes to the generated data, eg 'PROCESS INFORMATION'
    .
    default: 
 

-histo-type <8-bit|RGB> (property: histogramType)
    The type of histogram to generate.
    default: RGB
 

Version:

$Revision: 4779 $

Author:

fracpete (fracpete at waikato dot ac dot nz), Dale (dale at cs dot waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

static class

Histogram.HistogramType The type of histogram to generate.

Field Summary

protected Histogram.HistogramType

m_HistogramType the type of histogram to generate.

Fields inherited from class adams.data.image.AbstractImageFlattener

m_Fields, m_Header, m_Notes

Fields inherited from class adams.core.option.AbstractOptionHandler

m_DebugLevel, m_OptionManager

Constructor Summary

Histogram()

Method Summary

Instances	createHeader(ImagePlusContainer img) Creates the header from a template image.
void	defineOptions() Adds options to the internal list of options.
Instance[]	doFlatten(ImagePlusContainer img) Performs the actual flattening of the image.
Histogram.HistogramType	getHistogramType() Returns the type of histogram to generate.
String	globalInfo() Returns a string describing the object.
String	histogramTypeTipText() Returns the tip text for this property.
void	setHistogramType(Histogram.HistogramType value) Sets the type of histogram to generate.

Methods inherited from class adams.data.imagej.flattener.AbstractImageJFlattener

forCommandLine, forName, getFlatteners

Methods inherited from class adams.data.image.AbstractImageFlattener

checkImage, cleanUp, compareTo, destroy, equals, fieldsTipText, flatten, getFields, getNotes, newArray, notesTipText, postProcessHeader, postProcessInstance, reset, setFields, setNotes, shallowCopy, shallowCopy

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, debug, debug, debugLevelTipText, finishInit, getDebugLevel, getOptionManager, initialize, isDebugOn, newOptionManager, setDebugLevel, toCommandLine, toString

Methods inherited from class adams.core.ConsoleObject

getDebugging, getSystemErr, getSystemOut, sizeOf

Methods inherited from class java.lang.Object

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

Field Detail

m_HistogramType

protected Histogram.HistogramType m_HistogramType

the type of histogram to generate.

Constructor Detail

Histogram

public Histogram()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractImageFlattener<ImagePlusContainer>

setHistogramType

public void setHistogramType(Histogram.HistogramType value)

Sets the type of histogram to generate.

Parameters:

value - the type

getHistogramType

public Histogram.HistogramType getHistogramType()

Returns the type of histogram to generate.

Returns:

the type

histogramTypeTipText

public String histogramTypeTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

createHeader

public Instances createHeader(ImagePlusContainer img)

Creates the header from a template image.

Specified by:

createHeader in class AbstractImageFlattener<ImagePlusContainer>

Parameters:

img - the image to act as a template

Returns:

the generated header

doFlatten

public Instance[] doFlatten(ImagePlusContainer img)

Performs the actual flattening of the image.

Specified by:

doFlatten in class AbstractImageFlattener<ImagePlusContainer>

Parameters:

img - the image to process

Returns:

the generated array

See Also:

AbstractImageFlattener.m_Header