Functions

name description

fPhotoMode Returns the Mode value, indexed by name (Primary, Secondary, Family, Outside)

fPhotoModeN Returns the Mode name, indexed by value ()

fPhotoType Returns the PhotoType value, indexed by name (Galaxy, Star,...)

fMaskType Returns the MaskType value, indexed by name

fMaskTypeN Returns the MaskType name, indexed by value (3-> Galaxy, 6-> Star,...)

fPhotoTypeN Returns the PhotoType name, indexed by value (3-> Galaxy, 6-> Star,...)

fFieldQuality Returns bitmask of named field quality (e.g. ACCEPTABLE, BAD, GOOD, HOLE, MISSING)

fFieldQualityN Returns description of quality value (e.g. ACCEPTABLE, BAD, GOOD, HOLE, MISSING)

fPspStatus Returns the PspStatus value, indexed by name

fPspStatusN Returns the PspStatus name, indexed by value

fFramesStatus Returns the FramesStatus value, indexed by name

fFramesStatusN Returns the FramesStatus name, indexed by value

fSpecClass Returns the SpecClass value, indexed by name

fSpecClassN Returns the SpecClass name, indexed by value

fSpecZStatus Return the SpecZStatus value, indexed by name

fSpecZStatusN Return the SpecZStatus name, indexed by value

fSpecLineNames Return the SpecLineNames value, indexed by name

fSpecLineNamesN Return the SpecLineNames name, indexed by value

fHoleType Return the HoleType value, indexed by name

fHoleTypeN Return the HoleType name, indexed by value

fObjType Return the ObjType value, indexed by name

fObjTypeN Return the ObjType name, indexed by value

fProgramType Return the ProgramType value, indexed by name

fProgramTypeN Return the ProgramType name, indexed by value

fCoordType Return the CoordType value, indexed by name

fCoordTypeN Return the CoordType name, indexed by value

fFieldMask Returns mask value for a given name (e.g. 'seeing')

fFieldMaskN Returns description of mask value (e.g. 'SEEING PSF')

fPhotoFlags Returns the PhotoFlags value corresponding to a name

fPhotoFlagsN Returns the expanded PhotoFlags corresponding to the status value as a string

fPhotoStatus Returns the PhotoStatus flag value corresponding to a name

fPhotoStatusN Returns the string describing to the status flags in words

fPrimTarget Returns the PrimTarget value corresponding to a name

fPrimTargetN Returns the expanded PrimTarget corresponding to the flag value as a string

fSecTarget Returns the SecTarget value corresponding to a name

fSecTargetN Returns the expanded SecTarget corresponding to the flag value as a string

fInsideMask Returns the InsideMask value corresponding to a name

fInsideMaskN Returns the expanded InsideMask corresponding to the bits, as a string

fSpecZWarning Return the SpecZWarning value, indexed by name

fSpecZWarningN Return the expanded SpecZWarning corresponding to the flag value as a string

fImageMask Return the ImageMask flag value, indexed by name

fImageMaskN Return the expanded ImageMask corresponding to the flag value as a string

fTiMask Returns the TiMask value corresponding to a name

fTiMaskN Returns the expanded TiMask corresponding to the flag value as a string

fPhotoDescription Returns a string indicating Object type and object flags

fSpecDescription Returns a string indicating class, status and zWarning for a specObj

fCoordsFromEq Returns table of stripe, lambda, eta, mu, nu derived from ra,dec

fDMSbase Base function to convert declination in degrees to +dd:mm:ss.ss notation.

fEtaFromEq Returns eta from ra,dec

fHMSbase Base function to convert right ascension in degrees to +hh:mm:ss.ss notation.

fLambdaFromEq Returns lambda from ra,dec

fMuFromEq Returns mu from ra,dec

fGetNearbyObjAllEq Returns table of all objects within @r arcmins of an Equatorial point (@ra,@dec)

fNuFromEq Returns nu from ra,dec

fGetNearestObjAllEq Returns table holding a record describing the closest object within @r arcminutes of (@ra,@dec).

fGetNearestObjIdAllEq Returns the objId of nearest photo object within @r arcmins of ra, dec

fGetObjectsMaskEq A helper function for SDSS cutout that returns all objects within a certain radius of an (ra,dec)

fGetLat Converts a 3-vector to latitude (Galactic or Survey)

fEqFromMuNu Compute Equatorial coordinates from @mu and @nu

fMuNuFromEq Compute stripe coordinates from Equatorial

fRotateV3 Rotates a 3-vector by a given rotation matrix

fGetLonLat Converts a 3-vector to longitude-latitude (Galactic or Survey)

fGetLon Converts a 3-vector to longitude (Galactic or Survey)

fEtaToNormal Compute the normal vector from an eta value

fStripeToNormal Compute the normal vector from an eta value

fWedgeV3 Compute the wedge product of two vectors

fObj Extracts Obj from an SDSS Photo Object ID.

fObjidFromSDSS Computes the long objID from the 5-part SDSS numbers.

fHtmLookupError Returns the error message that fHtmLookup generated

fHtmCoverError Return error mesage for FhtmCover call telling what is wrong with Region definition.

fHtmToString Converts an HTM to a string representaion of that HTM

fHtmToNormalFormError Returns fHtmToNormalForm Error message

fHtmLookup Find the htmID of the specified point on the celestial sphere

fHtmCover Return table of HTM range pairs covering the region

fHtmToNormalForm Returns normal form of a region definition.

fHtmToVertices Returns returns (xyz)3 of an HTM triangle

fHtmToPoint Returns (xyz) of midpoint of an HTM triangle

fHtmVersion Returns HTM (Hierarchical Triangular Mesh) version string.

fHtmLookupXyz Returns HTM ID of a J2000 xyz point (@x,@y, @z).

fHtmLookupEq Returns 20-deep HTM ID of a given J2000 Equatorial point (@ra,@dec)

fHtmEq Returns 20-deep HTM ID of a given J2000 Equatorial point (@ra,@dec)

fHtmXyz Returns HTM ID of a pint a J2000 xyz point (@x,@y, @z).

fGetNearbyObjEq Returns table of primary objects within @r arcmins of an Equatorial point (@ra,@dec)

fRun Extracts Run from an SDSS Photo Object ID

fCamcol Extracts Camcol from an SDSS Photo Object ID

fField Extracts Field from an SDSS Photo Object ID.

fGetNearestObjEq Returns table holding a record describing the closest primary object within @r arcminutes of (@ra,@dec).

fGetNearestObjIdEq Returns the objId of nearest photoPrimary within @r arcmins of ra, dec

fGetNearestObjIdEqType Returns the objID of the nearest photPrimary of type @t within @r arcmin

fGetNearestObjIdEqMode Returns the objId of nearest @mode PhotoObjAll within @r arcmins of ra, dec

fGetNearbyObjXYZ Returns table of primary objects within @r arcmins of an xyz point (@nx,@ny, @nz).

fDistanceArcMinEq returns distance (arc minutes) between two points (ra1,dec1) and (ra2,dec2)

fDistanceArcMinXYZ returns distance (arc minutes) between two points (x1,y1,z1) and (x2,y2,z2)

fSkyVersion Extracts SkyVersion from an SDSS Photo Object ID

fRerun Extracts Rerun from an SDSS Photo Object ID

fGetNearbyObjAllXYZ Returns table of photo objects within @r arcmins of an xyz point (@nx,@ny, @nz).

fGetNearestObjXYZ Returns nearest primary object within @r arcminutes of an xyz point (@nx,@ny, @nz).

fGetNearbyFrameEq Returns table with a record describing the frames neareby (@ra,@dec) at a given @zoom level.

fGetNearestFrameEq Returns table with a record describing the nearest frame to (@ra,@dec) at a given @zoom level.

fGetNearestFrameidEq Returns teh fieldid of the nearest frame to (@ra,@dec) at a given @zoom level.

fObjID Match an objID to a PhotoObj and set/unset the first field bit.

fSDSS Computes the 6-part SDSS numbers from the long objID

fGetObjFromRect Returns table of objects inside a rectangle defined by two ra,dec pairs.
Note the order of the parameters: @ra1, @ra2, @dec1, @dec2

fGetObjectsEq A helper function for SDSS cutout that returns all objects within a certain radius of an (ra,dec)

fDMS Convert declination in degrees to +dd:mm:ss.ss notation

fHMS Convert right ascension in degrees to +hh:mm:ss.ss notation

fIAUFromEq Convert ra, dec in degrees to extended IAU name

fFirstFieldBit Returns the bit that indicates whether an objID is in the first field of a segment

fPrimaryObjID Match an objID to a PhotoPrimary and set/unset the first field bit.

fMagToFlux Convert Luptitudes to AB flux in nJy

fMagToFluxErr Convert the error in luptitudes to AB flux in nJy

fGetUrlExpId Returns the URL for an Photo objID.

fTokenNext Get token starting at offset @i in string @s

fTokenAdvance Get offset of next token after offset @i in string @s

fTokenStringToTable Returns a table containing the tokens in the input string

fNormalizeString Returns string upshifted, squeezed blanks, trailing zeros removed, and blank added on end

fRegionArcLength Computes the length of a directed arc in arcmins

fRegionConvexToArcs Returns the ordered arcs of a spherical Convex

fRegionStringToArcs Returns the ordered arcs of a Region joined with a regionString

fRegionToArcs Returns the ordered arcs of a spherical Region

fRegionBoundingCircle Returns the bounding circles of a Region

fRegionFuzz Returns a displacement that expands a circle by the 'buffer'

fRegionNormalizeString Returns the simplified version of a region string

fRegionConvexIdToString Return a normalized string description of the named convex (from the HalfSpace table).

fRegionIdToString Return a string description of the named region (from the HalfSpace table).

fRegionFromString Return a region table that describes the input region.

fRegionPredicate Returns predicate testing if a point (cx,cy,cz) point is inside the region

fRegionOverlap Returns regions of a given type overlapping a regionString

fRegionsContainingPointXYZ Returns regions containing a given point

fRegionsContainingPointEq Returns regions containing a given point

fRegionContainsPointXYZ Returns 1 if specified region contains specifed x,y,z point, else returns zero.

fSpecidFromSDSS Computes the long Spec IDs

fPlate Extracts plate from an SDSS Spec ID

fMJD Extracts MJD from an SDSS Spec ID

fFiber Extracts Fiber from an SDSS Spec ID

fRegionContainsPointEq Returns 1 if specified region contains specified ra,dec point, else returns zero.

fRegionGetObjectsFromRegionId Returns various objects within a region given by a regionid

fRegionGetObjectsFromString Returns various objects within a region given by a string

fRegionOverlapString Returns the overlap of a given region overlapping a regionString

fRegionOverlapId Returns the overlap of a given region overlapping another one

fFootprintEq Determine whether point is inside the survey

fIsNumbers Check that the substring is a valid number.

fGetUrlExpEq Returns the URL for an ra,dec, measured in degrees.

fDatediffSec fDatediffSec(start,now) returns the difference in seconds as a float

fGetUrlFrameImg Returns the URL for a JPG image of the frame

fGetUrlFitsField Given a FieldID returns the URL to the FITS file of that field

fGetUrlFitsCFrame Get the URL to the FITS file of a corrected frame given the fieldID and band

fGetUrlFitsMask Get the URL to the FITS file of a frame mask given the fieldID and band

fGetUrlFitsBin Get the URL to the FITS file of a binned frame given FieldID and band.

fGetUrlFitsAtlas Get the URL to the FITS file of all atlas images in a field

fGetUrlFitsSpectrum Get the URL to the FITS file of the spectrum given the SpecObjID

fGetUrlNavEq Returns the URL for an ra,dec, measured in degrees.

fGetUrlNavId Returns the Navigator URL for an Photo objID.

fGetUrlSpecImg Returns the URL for a GIF image of the spectrum given the SpecObjID

fDocColumns Return the list of Columns in a given table

fDocFunctionParams Return the parameters of a function

fEnum Converts @value in an enum table to a string

fMJDToGMT Computes the String of a Modified Julian Date.

fGetObjFromRectEq Returns table of objects inside a rectangle defined by two ra,dec pairs.
Note the order of the parameters: @ra1, @dec1, @ra2, @dec2

fReplace Case-insensitve string replacement

fStripeOfRun returns Stripe containing a particular run

fStripOfRun returns Strip containing a particular run

name	description
fPhotoMode	Returns the Mode value, indexed by name (Primary, Secondary, Family, Outside)
fPhotoModeN	Returns the Mode name, indexed by value ()
fPhotoType	Returns the PhotoType value, indexed by name (Galaxy, Star,...)
fMaskType	Returns the MaskType value, indexed by name
fMaskTypeN	Returns the MaskType name, indexed by value (3-> Galaxy, 6-> Star,...)
fPhotoTypeN	Returns the PhotoType name, indexed by value (3-> Galaxy, 6-> Star,...)
fFieldQuality	Returns bitmask of named field quality (e.g. ACCEPTABLE, BAD, GOOD, HOLE, MISSING)
fFieldQualityN	Returns description of quality value (e.g. ACCEPTABLE, BAD, GOOD, HOLE, MISSING)
fPspStatus	Returns the PspStatus value, indexed by name
fPspStatusN	Returns the PspStatus name, indexed by value
fFramesStatus	Returns the FramesStatus value, indexed by name
fFramesStatusN	Returns the FramesStatus name, indexed by value
fSpecClass	Returns the SpecClass value, indexed by name
fSpecClassN	Returns the SpecClass name, indexed by value
fSpecZStatus	Return the SpecZStatus value, indexed by name
fSpecZStatusN	Return the SpecZStatus name, indexed by value
fSpecLineNames	Return the SpecLineNames value, indexed by name
fSpecLineNamesN	Return the SpecLineNames name, indexed by value
fHoleType	Return the HoleType value, indexed by name
fHoleTypeN	Return the HoleType name, indexed by value
fObjType	Return the ObjType value, indexed by name
fObjTypeN	Return the ObjType name, indexed by value
fProgramType	Return the ProgramType value, indexed by name
fProgramTypeN	Return the ProgramType name, indexed by value
fCoordType	Return the CoordType value, indexed by name
fCoordTypeN	Return the CoordType name, indexed by value
fFieldMask	Returns mask value for a given name (e.g. 'seeing')
fFieldMaskN	Returns description of mask value (e.g. 'SEEING PSF')
fPhotoFlags	Returns the PhotoFlags value corresponding to a name
fPhotoFlagsN	Returns the expanded PhotoFlags corresponding to the status value as a string
fPhotoStatus	Returns the PhotoStatus flag value corresponding to a name
fPhotoStatusN	Returns the string describing to the status flags in words
fPrimTarget	Returns the PrimTarget value corresponding to a name
fPrimTargetN	Returns the expanded PrimTarget corresponding to the flag value as a string
fSecTarget	Returns the SecTarget value corresponding to a name
fSecTargetN	Returns the expanded SecTarget corresponding to the flag value as a string
fInsideMask	Returns the InsideMask value corresponding to a name
fInsideMaskN	Returns the expanded InsideMask corresponding to the bits, as a string
fSpecZWarning	Return the SpecZWarning value, indexed by name
fSpecZWarningN	Return the expanded SpecZWarning corresponding to the flag value as a string
fImageMask	Return the ImageMask flag value, indexed by name
fImageMaskN	Return the expanded ImageMask corresponding to the flag value as a string
fTiMask	Returns the TiMask value corresponding to a name
fTiMaskN	Returns the expanded TiMask corresponding to the flag value as a string
fPhotoDescription	Returns a string indicating Object type and object flags
fSpecDescription	Returns a string indicating class, status and zWarning for a specObj
fCoordsFromEq	Returns table of stripe, lambda, eta, mu, nu derived from ra,dec
fDMSbase	Base function to convert declination in degrees to +dd:mm:ss.ss notation.
fEtaFromEq	Returns eta from ra,dec
fHMSbase	Base function to convert right ascension in degrees to +hh:mm:ss.ss notation.
fLambdaFromEq	Returns lambda from ra,dec
fMuFromEq	Returns mu from ra,dec
fGetNearbyObjAllEq	Returns table of all objects within @r arcmins of an Equatorial point (@ra,@dec)
fNuFromEq	Returns nu from ra,dec
fGetNearestObjAllEq	Returns table holding a record describing the closest object within @r arcminutes of (@ra,@dec).
fGetNearestObjIdAllEq	Returns the objId of nearest photo object within @r arcmins of ra, dec
fGetObjectsMaskEq	A helper function for SDSS cutout that returns all objects within a certain radius of an (ra,dec)
fGetLat	Converts a 3-vector to latitude (Galactic or Survey)
fEqFromMuNu	Compute Equatorial coordinates from @mu and @nu
fMuNuFromEq	Compute stripe coordinates from Equatorial
fRotateV3	Rotates a 3-vector by a given rotation matrix
fGetLonLat	Converts a 3-vector to longitude-latitude (Galactic or Survey)
fGetLon	Converts a 3-vector to longitude (Galactic or Survey)
fEtaToNormal	Compute the normal vector from an eta value
fStripeToNormal	Compute the normal vector from an eta value
fWedgeV3	Compute the wedge product of two vectors
fObj	Extracts Obj from an SDSS Photo Object ID.
fObjidFromSDSS	Computes the long objID from the 5-part SDSS numbers.
fHtmLookupError	Returns the error message that fHtmLookup generated
fHtmCoverError	Return error mesage for FhtmCover call telling what is wrong with Region definition.
fHtmToString	Converts an HTM to a string representaion of that HTM
fHtmToNormalFormError	Returns fHtmToNormalForm Error message
fHtmLookup	Find the htmID of the specified point on the celestial sphere
fHtmCover	Return table of HTM range pairs covering the region
fHtmToNormalForm	Returns normal form of a region definition.
fHtmToVertices	Returns returns (xyz)3 of an HTM triangle
fHtmToPoint	Returns (xyz) of midpoint of an HTM triangle
fHtmVersion	Returns HTM (Hierarchical Triangular Mesh) version string.
fHtmLookupXyz	Returns HTM ID of a J2000 xyz point (@x,@y, @z).
fHtmLookupEq	Returns 20-deep HTM ID of a given J2000 Equatorial point (@ra,@dec)
fHtmEq	Returns 20-deep HTM ID of a given J2000 Equatorial point (@ra,@dec)
fHtmXyz	Returns HTM ID of a pint a J2000 xyz point (@x,@y, @z).
fGetNearbyObjEq	Returns table of primary objects within @r arcmins of an Equatorial point (@ra,@dec)
fRun	Extracts Run from an SDSS Photo Object ID
fCamcol	Extracts Camcol from an SDSS Photo Object ID
fField	Extracts Field from an SDSS Photo Object ID.
fGetNearestObjEq	Returns table holding a record describing the closest primary object within @r arcminutes of (@ra,@dec).
fGetNearestObjIdEq	Returns the objId of nearest photoPrimary within @r arcmins of ra, dec
fGetNearestObjIdEqType	Returns the objID of the nearest photPrimary of type @t within @r arcmin
fGetNearestObjIdEqMode	Returns the objId of nearest @mode PhotoObjAll within @r arcmins of ra, dec
fGetNearbyObjXYZ	Returns table of primary objects within @r arcmins of an xyz point (@nx,@ny, @nz).
fDistanceArcMinEq	returns distance (arc minutes) between two points (ra1,dec1) and (ra2,dec2)
fDistanceArcMinXYZ	returns distance (arc minutes) between two points (x1,y1,z1) and (x2,y2,z2)
fSkyVersion	Extracts SkyVersion from an SDSS Photo Object ID
fRerun	Extracts Rerun from an SDSS Photo Object ID
fGetNearbyObjAllXYZ	Returns table of photo objects within @r arcmins of an xyz point (@nx,@ny, @nz).
fGetNearestObjXYZ	Returns nearest primary object within @r arcminutes of an xyz point (@nx,@ny, @nz).
fGetNearbyFrameEq	Returns table with a record describing the frames neareby (@ra,@dec) at a given @zoom level.
fGetNearestFrameEq	Returns table with a record describing the nearest frame to (@ra,@dec) at a given @zoom level.
fGetNearestFrameidEq	Returns teh fieldid of the nearest frame to (@ra,@dec) at a given @zoom level.
fObjID	Match an objID to a PhotoObj and set/unset the first field bit.
fSDSS	Computes the 6-part SDSS numbers from the long objID
fGetObjFromRect	Returns table of objects inside a rectangle defined by two ra,dec pairs. Note the order of the parameters: @ra1, @ra2, @dec1, @dec2
fGetObjectsEq	A helper function for SDSS cutout that returns all objects within a certain radius of an (ra,dec)
fDMS	Convert declination in degrees to +dd:mm:ss.ss notation
fHMS	Convert right ascension in degrees to +hh:mm:ss.ss notation
fIAUFromEq	Convert ra, dec in degrees to extended IAU name
fFirstFieldBit	Returns the bit that indicates whether an objID is in the first field of a segment
fPrimaryObjID	Match an objID to a PhotoPrimary and set/unset the first field bit.
fMagToFlux	Convert Luptitudes to AB flux in nJy
fMagToFluxErr	Convert the error in luptitudes to AB flux in nJy
fGetUrlExpId	Returns the URL for an Photo objID.
fTokenNext	Get token starting at offset @i in string @s
fTokenAdvance	Get offset of next token after offset @i in string @s
fTokenStringToTable	Returns a table containing the tokens in the input string
fNormalizeString	Returns string upshifted, squeezed blanks, trailing zeros removed, and blank added on end
fRegionArcLength	Computes the length of a directed arc in arcmins
fRegionConvexToArcs	Returns the ordered arcs of a spherical Convex
fRegionStringToArcs	Returns the ordered arcs of a Region joined with a regionString
fRegionToArcs	Returns the ordered arcs of a spherical Region
fRegionBoundingCircle	Returns the bounding circles of a Region
fRegionFuzz	Returns a displacement that expands a circle by the 'buffer'
fRegionNormalizeString	Returns the simplified version of a region string
fRegionConvexIdToString	Return a normalized string description of the named convex (from the HalfSpace table).
fRegionIdToString	Return a string description of the named region (from the HalfSpace table).
fRegionFromString	Return a region table that describes the input region.
fRegionPredicate	Returns predicate testing if a point (cx,cy,cz) point is inside the region
fRegionOverlap	Returns regions of a given type overlapping a regionString
fRegionsContainingPointXYZ	Returns regions containing a given point
fRegionsContainingPointEq	Returns regions containing a given point
fRegionContainsPointXYZ	Returns 1 if specified region contains specifed x,y,z point, else returns zero.
fSpecidFromSDSS	Computes the long Spec IDs
fPlate	Extracts plate from an SDSS Spec ID
fMJD	Extracts MJD from an SDSS Spec ID
fFiber	Extracts Fiber from an SDSS Spec ID
fRegionContainsPointEq	Returns 1 if specified region contains specified ra,dec point, else returns zero.
fRegionGetObjectsFromRegionId	Returns various objects within a region given by a regionid
fRegionGetObjectsFromString	Returns various objects within a region given by a string
fRegionOverlapString	Returns the overlap of a given region overlapping a regionString
fRegionOverlapId	Returns the overlap of a given region overlapping another one
fFootprintEq	Determine whether point is inside the survey
fIsNumbers	Check that the substring is a valid number.
fGetUrlExpEq	Returns the URL for an ra,dec, measured in degrees.
fDatediffSec	fDatediffSec(start,now) returns the difference in seconds as a float
fGetUrlFrameImg	Returns the URL for a JPG image of the frame
fGetUrlFitsField	Given a FieldID returns the URL to the FITS file of that field
fGetUrlFitsCFrame	Get the URL to the FITS file of a corrected frame given the fieldID and band
fGetUrlFitsMask	Get the URL to the FITS file of a frame mask given the fieldID and band
fGetUrlFitsBin	Get the URL to the FITS file of a binned frame given FieldID and band.
fGetUrlFitsAtlas	Get the URL to the FITS file of all atlas images in a field
fGetUrlFitsSpectrum	Get the URL to the FITS file of the spectrum given the SpecObjID
fGetUrlNavEq	Returns the URL for an ra,dec, measured in degrees.
fGetUrlNavId	Returns the Navigator URL for an Photo objID.
fGetUrlSpecImg	Returns the URL for a GIF image of the spectrum given the SpecObjID
fDocColumns	Return the list of Columns in a given table
fDocFunctionParams	Return the parameters of a function
fEnum	Converts @value in an enum table to a string
fMJDToGMT	Computes the String of a Modified Julian Date.
fGetObjFromRectEq	Returns table of objects inside a rectangle defined by two ra,dec pairs. Note the order of the parameters: @ra1, @dec1, @ra2, @dec2
fReplace	Case-insensitve string replacement
fStripeOfRun	returns Stripe containing a particular run
fStripOfRun	returns Strip containing a particular run