herschel.ia.toolbox.cube

Class ImportCubeTask

java.lang.Object

herschel.ia.task.Task

herschel.ia.toolbox.cube.ImportCubeTask

All Implemented Interfaces:

TaskApi

public class ImportCubeTask
extends Task

ImportSpectralCubeTask is a task which imports a Cube from a fits file.

See Also:

Cube, Task

Nested Class Summary

Nested classes/interfaces inherited from class herschel.ia.task.Task

Task.HistoryRecordingType, Task.JythonAddListener, Task.JythonSetAsDefault

Field Summary

Fields

Modifier and Type	Field and Description
static org.python.core.PyString	__doc__ documentation.

Constructor Summary

Constructors

Constructor and Description
ImportCubeTask() Imports a cube.

Method Summary

Modifier and Type	Method and Description
TaskParameter	buildParameterlocal(String name, Class<?> type, SignatureEntry.Type io, String description) Utility method to create a (partially) configured Parameter.
protected void	checkWcsCtype(Wcs wcs) check the ctype in the wcs.
protected Wcs	checkWcsUnit(SimpleCube cube, Product p) check the unit in the WCS.
void	execute() Task registered to work on SimpleCube.
Map<String,Modifier>	getCustomModifiers() Returns the custom modifiers value.
protected void	useHcssReader(SimpleCube cube, String filename, FitsArchive fa) a method to read a fits file with a hcss product.

Methods inherited from class herschel.ia.task.Task

__call__, accept, addListener, addOutput, addTaskParameter, addTaskParameter, advance, advance, canBeApplicable, checkInterrupted, checkInterrupted, getClassName, getDeprecatedWith, getDescription, getGroups, getHistoryRecording, getLogger, getName, getOutput, getParameter, getSignature, getSourcePath, getValue, getViews, isJythonTask, outToIndex, outToIndex, perform, postamble, preamble, removeListener, reset, setAsDefaultValue, setDeprecatedWith, setDescription, setHistoryRecording, setName, setProgress, setSignature, setStatus, setStatusMessage, setValue, toString

Methods inherited from class java.lang.Object

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

Field Detail

__doc__

public static org.python.core.PyString __doc__

documentation.

Constructor Detail

ImportCubeTask

public ImportCubeTask()

Imports a cube.

Method Detail

getCustomModifiers

public Map<String,Modifier> getCustomModifiers()

Returns the custom modifiers value.

Specified by:

getCustomModifiers in interface TaskApi

Overrides:

getCustomModifiers in class Task

Returns:

a list of modifier

execute

public void execute()

Task registered to work on SimpleCube.

Specified by:

execute in interface TaskApi

Overrides:

execute in class Task

Throws:

CubeTaskException

checkWcsCtype

protected void checkWcsCtype(Wcs wcs)

check the ctype in the wcs.

Parameters:

wcs - the wcs to check

checkWcsUnit

protected Wcs checkWcsUnit(SimpleCube cube,
                           Product p)

check the unit in the WCS.

Parameters:

cube - the cube to check

p - the product to import

Returns:

the wcs

useHcssReader

protected void useHcssReader(SimpleCube cube,
                             String filename,
                             FitsArchive fa)

a method to read a fits file with a hcss product.

Parameters:

cube - the cube to fill

filename - the name of the file to read

fa - a pointer on a fits archive

buildParameterlocal

public TaskParameter buildParameterlocal(String name,
                                         Class<?> type,
                                         SignatureEntry.Type io,
                                         String description)

Utility method to create a (partially) configured Parameter.

Parameters:

name - parameter name

type - class

io - INPUT, INOUT, OUTPUT

description - the text that describes the parameter (for tooltips, if null or empty it will not be used)

Returns:

the configured TaskParameter