|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object edu.jhu.ece.iacl.jist.pipeline.PipePort<T> edu.jhu.ece.iacl.jist.pipeline.parameter.ParamModel<java.io.File> edu.jhu.ece.iacl.jist.pipeline.parameter.ParamFile edu.jhu.ece.iacl.jist.pipeline.parameter.ParamObject<ImageData> edu.jhu.ece.iacl.jist.pipeline.parameter.ParamVolume
public class ParamVolume
Parameter volume specifies a CubicVolume with restrictions for the dimensions and data type.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class edu.jhu.ece.iacl.jist.pipeline.parameter.ParamFile |
---|
ParamFile.DialogType |
Nested classes/interfaces inherited from class edu.jhu.ece.iacl.jist.pipeline.PipePort |
---|
PipePort.PortListener, PipePort.type |
Field Summary | |
---|---|
protected int |
cols
The cols. |
protected int |
components
The components. |
protected int |
rows
The rows. |
protected int |
slices
The slices. |
protected ImageData |
volume
The volume. |
protected VoxelType |
voxelType
The voxel type. |
Fields inherited from class edu.jhu.ece.iacl.jist.pipeline.parameter.ParamObject |
---|
obj, readerWriter |
Fields inherited from class edu.jhu.ece.iacl.jist.pipeline.parameter.ParamFile |
---|
dialogType, extensionFilter, file, uri |
Fields inherited from class edu.jhu.ece.iacl.jist.pipeline.parameter.ParamModel |
---|
cliTag, description, factory, hidden, label, loadAndSaveOnValidate, mandatory, shortLabel |
Fields inherited from class edu.jhu.ece.iacl.jist.pipeline.PipePort |
---|
connectible, gport, incomingConnectors, listeners, maxIncoming, maxOutgoing, outgoingConnectors, owner, portType, useWire |
Constructor Summary | |
---|---|
ParamVolume()
Default constructor. |
|
ParamVolume(java.lang.String name)
Constructor. |
|
ParamVolume(java.lang.String name,
VoxelType type)
Constructor. |
|
ParamVolume(java.lang.String name,
VoxelType type,
int rows,
int cols,
int slices,
int components)
Construct volume parameter with a restriction on the dimensions and data type. |
|
ParamVolume(VoxelType type)
Construct volume parameter with a restriction on the data type. |
|
ParamVolume(VoxelType type,
int rows,
int cols,
int slices,
int components)
Construct volume parameter with a restriction on the dimensions and data type. |
Method Summary | |
---|---|
void |
clear()
Clear volume parameter. |
ParamVolume |
clone()
Clone object. |
int |
compareTo(ParamModel model)
Compare restrictions of parameters. |
void |
dispose()
Dispose of volume in memory. |
boolean |
equalVolume(java.lang.Object obj)
Compare parameter volumes by model image names. |
int |
getCols()
Get column restriction. |
int |
getComponents()
Get component restriction. |
ImageData |
getImageData()
Get the CubicVolume specified. |
ImageData |
getImageData(boolean loadIfNotLoaded)
|
java.lang.String |
getName()
Get the parameter's name, which should be unique. |
ImageData |
getObject()
Deprecated. |
int |
getRows()
Get row restriction. |
int |
getSlices()
Get slice restriction. |
java.io.File |
getValue()
Get file location of Model Image if it exists. |
VoxelType |
getVoxelType()
Get voxel type restriction. |
void |
init()
Initialize parameter. |
boolean |
isCompatible(PipePort model)
Returns true if port is compatible with this parameter's extension filter. |
void |
setObject(ImageData obj)
Set volume. |
void |
setValue(java.io.File file)
Set volume filename. |
void |
setValue(ImageData value)
Set the value for the parameter. |
void |
setValue(java.net.URI uri)
Set volume filename. |
java.lang.String |
toString()
Get volume description. |
void |
validate()
Validate volume. |
void |
writeAndFreeNow(ProcessingAlgorithm src)
Attempt to export the current parameter now, and, if possible, free associated memory. |
Methods inherited from class edu.jhu.ece.iacl.jist.pipeline.parameter.ParamObject |
---|
getReaderWriter, setFileName, setReaderWriter, setValue, writeObject |
Methods inherited from class edu.jhu.ece.iacl.jist.pipeline.parameter.ParamFile |
---|
clean, getDialogType, getExtensionFilter, getHumanReadableDataType, getURI, getXMLValue, probeDefaultValue, replacePath, setExtensionFilter, setXMLValue, translatePath |
Methods inherited from class edu.jhu.ece.iacl.jist.pipeline.parameter.ParamModel |
---|
createMipavParameter, createTreeNode, equals, getCliTag, getDescription, getFactory, getInputView, getLabel, getOutputView, getShortLabel, getView, hide, importMipavParameter, importParameter, isConnectible, isHidden, isMandatory, loadResources, loadResources, read, read, saveResources, setCliTag, setDescription, setFactory, setHidden, setInputView, setLabel, setLoadAndSaveOnValidate, setMandatory, setName, setOutputView, setShortLabel, toXML, write, write |
Methods inherited from class edu.jhu.ece.iacl.jist.pipeline.PipePort |
---|
addListener, disconnect, disconnect, disconnect, disconnect, getGraphPort, getIncomingConnector, getIncomingConnectors, getIncomingPorts, getListeners, getMaxIncoming, getMaxOutgoing, getOutgoingConnector, getOutgoingConnectors, getOutgoingPorts, getOwner, getPortType, isConnected, isConnectedTo, isInputPort, isOutputPort, notifyListenersOfConnection, notifyListenersOfDisconnection, removeAllListeners, removeListener, setConnectable, setGraphPort, setMaxIncoming, setMaxOutgoing, setOwner, setPortType, setUseConnector, usingConnector |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected int rows
protected int cols
protected int slices
protected int components
protected VoxelType voxelType
protected transient ImageData volume
Constructor Detail |
---|
public ParamVolume()
public ParamVolume(java.lang.String name)
name
- parameter namepublic ParamVolume(java.lang.String name, VoxelType type)
name
- parameter nametype
- voxel type restrictionpublic ParamVolume(java.lang.String name, VoxelType type, int rows, int cols, int slices, int components)
name
- volume nametype
- data type restrictionrows
- rows restrictioncols
- columns restrictionslices
- slices restrictioncomponents
- components restrictionpublic ParamVolume(VoxelType type)
type
- data type restrictionpublic ParamVolume(VoxelType type, int rows, int cols, int slices, int components)
type
- data type restrictionrows
- rows restrictioncols
- columns restrictionslices
- slices restrictioncomponents
- components restrictionMethod Detail |
---|
public void clear()
public ParamVolume clone()
clone
in class ParamObject<ImageData>
public int compareTo(ParamModel model)
compareTo
in interface java.lang.Comparable<ParamModel>
compareTo
in class ParamFile
model
- the model
public void dispose()
dispose
in class ParamModel<java.io.File>
public boolean equalVolume(java.lang.Object obj)
obj
- a parameter volume or a string image name
public int getCols()
public int getComponents()
@Deprecated public ImageData getObject()
ParamObject
getObject
in class ParamObject<ImageData>
public int getRows()
public int getSlices()
public java.io.File getValue()
getValue
in class ParamFile
public java.lang.String getName()
ParamModel
getName
in class ParamModel<java.io.File>
public ImageData getImageData()
public ImageData getImageData(boolean loadIfNotLoaded)
public VoxelType getVoxelType()
public void init()
init
in class ParamObject<ImageData>
public boolean isCompatible(PipePort model)
ParamFile
isCompatible
in class ParamFile
model
- the model
public void setObject(ImageData obj)
setObject
in class ParamObject<ImageData>
obj
- the objpublic void setValue(ImageData value)
value
- parameter valuepublic void setValue(java.io.File file)
setValue
in class ParamObject<ImageData>
file
- the filepublic void setValue(java.net.URI uri)
setValue
in class ParamFile
file
- the filepublic java.lang.String toString()
toString
in class ParamObject<ImageData>
public void validate() throws InvalidParameterException
validate
in class ParamObject<ImageData>
InvalidParameterException
- the invalid parameter exceptionpublic void writeAndFreeNow(ProcessingAlgorithm src)
ParamModel
writeAndFreeNow
in class ParamModel<java.io.File>
src
- - Parent ProcessingAlgorithm needed to determine output location
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |