Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CHANNEL_SUFFIX
file name suffix
|
static java.util.regex.Pattern |
hexIdPattern
Pattern to match hex form of Channel IDs
|
static java.lang.String |
ID
CVS ID
|
static java.util.regex.Pattern |
idPattern
Pattern to match non-hex form of Channel IDs
|
static java.lang.String |
MRO_HiRISE_RSDS_PREFIX
prefix specific to MRO HiRISE
|
Constructor and Description |
---|
Channel(Observation observation,
int cpmmNumber,
int channel)
Construct a new Channel for the given Observation, CPMM number and
channel number.
|
Channel(Observation observation,
java.lang.String ccdName,
int channel)
Construct a new Channel for the given Observation, CCD name and
channel number.
|
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
clone()
Clone this Channel
|
int |
compareTo(Channel channel) |
boolean |
equals(java.lang.Object object)
Compare this Channel to another for equality.
|
java.lang.String |
getCcdName()
Get the CCD name for this channel.
|
int |
getChannelNumber()
Get the channel number for this channel
|
int |
getCpmmNumber()
Get the CPMM number
|
java.lang.String |
getFilterName()
Get the filter name for this channel
|
java.lang.String |
getName()
Get the name of this channel, e.g.
|
Observation |
getObservation()
Get the observation that this Channel is a part of.
|
java.lang.String |
getRsdsFilename(boolean gapped)
Get the filename for this Channel as it would appear on the RSDS.
|
int |
getVersion()
Get the version number for this channel, which defaults to 1 if it
has not been set.
|
int |
hashCode()
Get a hash code for this Channel
|
static Channel |
parse(java.lang.String id)
Construct a new Channel
|
static Channel |
parseHex(java.lang.String id)
Construct a new Channel
|
void |
setVersion(int version)
Set the version number for this channel, used in the hex form of the ID.
|
java.lang.String |
toString()
Get the String form of the channel.
|
public static final java.lang.String ID
public static final java.lang.String MRO_HiRISE_RSDS_PREFIX
public static final java.lang.String CHANNEL_SUFFIX
public static final java.util.regex.Pattern idPattern
public static final java.util.regex.Pattern hexIdPattern
public Channel(Observation observation, int cpmmNumber, int channel) throws Invalid_Argument_Exception
observation
- The observationcpmmNumber
- Index into the Instrument.CCD_NAMES arraychannel
- 0 or 1Invalid_Argument_Exception
- Bad channel or CPMM numberpublic Channel(Observation observation, java.lang.String ccdName, int channel) throws Invalid_Argument_Exception
observation
- Observation instanceccdName
- Name of CCDchannel
- Channel NumberInvalid_Argument_Exception
- Bad channel number or CCD namepublic static Channel parse(java.lang.String id) throws Invalid_Argument_Exception
id
- String containing Channel idInvalid_Argument_Exception
- Bad Channel IDpublic static Channel parseHex(java.lang.String id) throws Invalid_Argument_Exception
id
- String containing Channel idInvalid_Argument_Exception
- Bad hex Channel IDpublic java.lang.String getRsdsFilename(boolean gapped)
gapped
- True if this is a gapped channelpublic java.lang.String getName()
public int getVersion()
public void setVersion(int version) throws Invalid_Argument_Exception
version
- NumberInvalid_Argument_Exception
- Bad version numberpublic java.lang.String toString()
toString
in class java.lang.Object
public Observation getObservation()
public final java.lang.Object clone() throws java.lang.CloneNotSupportedException
clone
in class java.lang.Object
java.lang.CloneNotSupportedException
public boolean equals(java.lang.Object object)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public int compareTo(Channel channel)
compareTo
in interface java.lang.Comparable<Channel>
Comparable
public int getCpmmNumber()
public java.lang.String getCcdName()
public int getChannelNumber()
public java.lang.String getFilterName()
Copyright \ (C) Arizona Board of Regents on behalf of the \ Planetary Image Research Laboratory, Lunar and \ Planetary Laboratory at the University of Arizona