|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object edu.nrao.sss.model.resource.CorrelatorBasebandAbs edu.nrao.sss.model.resource.evla.WidarBaseband edu.nrao.sss.model.resource.evla.WidarBasebandSinglet
public class WidarBasebandSinglet
An unpaired baseband of the WIDAR correlator.
Version Info:
$Revision: 2271 $ |
$Date: 2009-04-28 12:02:17 -0600 (Tue, 28 Apr 2009) $ |
$Author: dharland $ (last person to modify) |
Field Summary |
---|
Fields inherited from class edu.nrao.sss.model.resource.CorrelatorBasebandAbs |
---|
bandwidth, subbands |
Fields inherited from interface edu.nrao.sss.util.Identifiable |
---|
UNIDENTIFIED |
Constructor Summary | |
---|---|
protected |
WidarBasebandSinglet()
|
protected |
WidarBasebandSinglet(DigitalSignal input)
Helps create a new WIDAR baseband. |
Method Summary | |
---|---|
WidarBasebandSinglet |
clone()
Returns a copy of this baseband. |
boolean |
equals(Object o)
Returns true if o is equal to this baseband. |
static WidarBasebandSinglet |
fromXml(Reader reader)
Creates a new baseband based on the XML data read from reader . |
static WidarBasebandSinglet |
fromXml(String xmlFile)
Creates a new baseband from the XML data in the given file. |
int |
getInitialQuantization()
Returns the number of bits per sample in this baseband. |
String |
getName()
Returns the name of this baseband. |
WidarBaseband |
getPartner()
Returns the partner of this baseband, if any. |
PolarizationType |
getPolarization()
Returns the polarization of the signal represented by this baseband. |
List<PolarizationType> |
getPolarizations()
Returns the polarizations of the signals represented by this baseband. |
FrequencyRange |
getProxiedRange()
Returns the portion of frequency space for which this baseband is a proxy. |
int |
hashCode()
Returns a hash code value for this baseband. |
boolean |
hasPartner()
Returns true if this baseband has a partner. |
boolean |
isPartnerOf(WidarBaseband other)
Returns true if other is loosely partnered with this baseband. |
boolean |
isSinglet()
Returns true if this is an unpaired, or singlet, baseband. |
boolean |
proxiedRangeIsReversed()
Returns true if the high and low frequencies in the proxied range are mapped to the low and high frequencies, respectively, of this baseband. |
protected void |
setInput(DigitalSignal input)
Sets the input signal for this baseband. |
Methods inherited from class edu.nrao.sss.model.resource.CorrelatorBasebandAbs |
---|
addNewSubband, clearId, createdSubbandsFromPersistentStore, getAllowableBandwidthClosestTo, getAllowableBandwidthFor, getBandwidth, getId, getProxiedRange, getSubbandCount, getSubbands, isPair, removeAllSubbands, removeOldSubband, removeSubbandAt, toString |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
protected WidarBasebandSinglet(DigitalSignal input)
IllegalArgumentException
- if input
is null.protected WidarBasebandSinglet()
Method Detail |
---|
protected void setInput(DigitalSignal input)
public String getName()
CorrelatorBaseband
public boolean isSinglet()
CorrelatorBaseband
polarizations
represented by this baseband
should be one.
Either this method or CorrelatorBaseband.isPair()
, but not both, should
be true. Only single and paired basebands are anticipated.
public FrequencyRange getProxiedRange()
CorrelatorBaseband
public boolean proxiedRangeIsReversed()
CorrelatorBaseband
An example where the return value of this method would be true is if this baseband had a width of 2 GHz and proxied an original range of 45 GHz - 43 GHz, respectively. That is, the 2 GHz signal in the baseband would represent 45 GHz, 1 GHz would represent 44 GHz, and 0 GHz would represent 43 GHz.
public int getInitialQuantization()
CorrelatorBaseband
public PolarizationType getPolarization()
public List<PolarizationType> getPolarizations()
CorrelatorBaseband
public boolean isPartnerOf(WidarBaseband other)
WidarBaseband
isPartnerOf
in class WidarBaseband
other
- another WIDAR baseband that may or may not be a partner of this one.
public boolean hasPartner()
WidarBaseband
hasPartner
in class WidarBaseband
public WidarBaseband getPartner()
WidarBaseband
Even unpaired basebands have some coupling to one other baseband, due to the correlator hardware.
getPartner
in class WidarBaseband
public static WidarBasebandSinglet fromXml(String xmlFile) throws JAXBException, XMLStreamException, FileNotFoundException
xmlFile
- the name of an XML file. This method will attempt to locate
the file by using Class.getResource(String)
.
FileNotFoundException
- if the XML file cannot be found.
JAXBException
- if the schema file used (if any) is malformed, if the XML file cannot be
read, or if the XML file is not schema-valid.
XMLStreamException
- if there is a problem opening the XML file, if the XML is not well-formed,
or for some other "unexpected processing conditions".public static WidarBasebandSinglet fromXml(Reader reader) throws JAXBException, XMLStreamException
reader
.
reader
- the source of the XML data.
If this value is null, null is returned.
reader
.
XMLStreamException
- if the XML is not well-formed,
or for some other "unexpected processing conditions".
JAXBException
- if anything else goes wrong during the transformation.public WidarBasebandSinglet clone()
If anything goes wrong during the cloning procedure,
a RuntimeException
will be thrown.
clone
in interface CorrelatorBaseband
clone
in class WidarBaseband
public boolean equals(Object o)
o
is equal to this baseband.
equals
in class WidarBaseband
public int hashCode()
hashCode
in class WidarBaseband
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |