yafitss package

Subpackages

• yafitss.tests package
  • Submodules
  • yafitss.tests.test_DataBlocktest module
  • Module contents

Submodules

yafitss.dataBlock module

class yafitss.dataBlock.DataBlock(logger, timer)

Bases: object

A class to pack the content of a FITS file (IMAGE) and related data.

__palette_names

the palette names

Type

string list

__palette

to

Type

???

__default_palette_name

the default palette name

Type

str

__transformation_names

the transformation names

Type

str list

__default_transformation_name

the default transformation name

Type

str

__video_mode_names

the video mode names

Type

str list

__default_video_mode_name

the default video mode name

Type

str

__renderingCapabilities

the rendering capabilities

Type

dictionary

__dateTimeFormat

date time format

Type

str

__naxisn_rexp

a regulare expression to catch the NAXISn

Type

str

__max_idle

maximum idleness duration for an instance of DataBlock, retrieved from the env var YAFITSS_MAXIDLE

Type

float

RADECRangeInDegrees() → result.Result

addHeaderToFits(iRA, iDEC, iRA1, iDEC1, data_spectrum, spectrumUnit)

Create new fits HDU from the one given by the origin fits file :param iRA: first x coordinate :type iRA: str :param iDEC: first y coordinate :type iDEC: str :param iRA1: second x coordinate :type iRA1: str :param iDEC1: second y coordinate :type iDEC1: str :param data_spectrum: a table (x,y) of data used to create the spectrum :type data_spectrum: list :param spectrumUnit: selected unit of the average or simple spectrum :type spectrumUnit: str

Returns

hdu – Primary HDU of the spectrum

Return type

dictionary

classmethod convert_size(sizeInBytes)

Convert size in byte format :param cls: :type cls: DataBlock :param sizeInBytes: :type sizeInBytes: int

Returns

a byte format

Return type

string

createFITSImage(iFREQ, iFREQ1, imageType, step=1)

createFITSSliceImage0(iFREQ) → result.Result

createFITSSumSliceImage0(iFREQ0, iFREQ1) → result.Result

createFits(iRA, iDEC) → result.Result

createOneSlice(iFREQ, Header, step)

createSmoothCube(nbox)

createSmoothCube0(nbox) → result.Result

createSummedSlice(iFREQ0, iFREQ1, Header, step)

property creationTime

degToHMSDMS(RAinDD, DECinDD) → result.Result

getAverage(iFREQ0=None, iFREQ1=None, iDEC0=None, iDEC1=None, iRA0=None, iRA1=None) → result.Result

Returns value at given position in summed slice. If value is NaN or does not exist, it is replaced by None to get a valid json document after conversion

Parameters

• iFREQ0 (int) – Frequency of first slice

• iFREQ1 (int) – Frequency of last slice

• iDEC0 (int) – iDEC min

• iDEC1 (int) – iDEC max

• iRA0 (int) – iRA min

• iRA1 (int) – iRA max

Returns

result

Return type

array

getAverageSpectrum(iDEC0=None, iDEC1=None, iRA0=None, iRA1=None) → result.Result

getContours(iFREQ=None, iDEC0=None, iDEC1=None, iRA0=None, iRA1=None, **kwargs) → result.Result

classmethod getDataBlockInfoNames()

getDataBlockInfos(now, infoNames) → result.Result

classmethod getDateTimeFormat()

classmethod getDefaultITTName()

classmethod getDefaultLUTName()

classmethod getDefaultPaletteName()

classmethod getDefaultTransformationName()

classmethod getDefaultVMName()

classmethod getDefaultVideoModeName()

classmethod getDefaults()

getDimensions() → result.Result

classmethod getFITSFilePrefix()

getHeader() → result.Result

classmethod getIMGFilePrefix()

classmethod getMaxIdle()

classmethod getOBJFilePrefix()

getOneSliceAsPNG(iFREQ, ittName='percent99', lutName='iram', vmName='direct') → result.Result

Get One slice as a png image :param iFREQ: :type iFREQ: float

Returns

result

Return type

dictionary

classmethod getPNGFilePrefix()

classmethod getPaletteFromName(name)

getPixelValueAtiFreqiRAiDEC(iFreq, iRA, iDEC) → result.Result

getPixelValueAtiRAiDEC(iRA: int, iDEC: int) → result.Result

getPixelsValueAtiFreqiRAiDEC(iPositions) → result.Result

classmethod getRenderingCapabilities()

classmethod getSMOOTHFilePrefix()

getSlice(iFREQ, step=1) → result.Result

getSpectrum(iRA=None, iDEC=None, iFREQ0=None, iFREQ1=None) → result.Result

getSumOverSliceRectArea(iFREQ, iRA0=None, iRA1=None, iDEC0=None, iDEC1=None) → result.Result

getSummedSliceRangeAsPNG(iFREQ0, iFREQ1, ittName='percent99', lutName='iram', vmName='direct') → result.Result

getlastAccess() → result.Result

property header

property infod

is3D()

property lastAccess

measureBox(iFREQ, iRA0=None, iRA1=None, iDEC0=None, iDEC1=None) → result.Result

measureContour(iFREQ, contour, level) → result.Result

property naxisn

rangeToDMS(iDEC0, iDEC1, iDECstep) → result.Result

rangeToHMS(iRA0: int, iRA1: int, iRAstep) → result.Result

property relFITSFilePath

setData(relFITSFilePath: str) → result.Result

Given a FITS file path: read the content of the FITS file in memory and populates the instance variables accordingly

Parameters

relFITSFilePath (str) – a relative fits file path

Returns

a formated result

Return type

Result

Raises

• KeyError – if the __header[“RESTFRQ”] does not exist

• Exception – Error while opening fits file

classmethod setFITSFilePrefix(FITSFilePrefix)

classmethod setIMGFilePrefix(IMGFilePrefix)

setLastAccess()

Set a lastAccess on self

classmethod setOBJFilePrefix(OBJFilePrefix)

classmethod setPNGFilePrefix(PNGFilePrefix)

classmethod setSMOOTHFilePrefix(SMOOTHFilePrefix)

property sizeInBytes

slice_smbox_cube(incube, nbox)

yafitss.dataBlock.cmap2palette(palette_name)

yafitss.dataBlock.getLegendFilePath(pngFilePath)

yafitss.dataBlock.isNanList(checked_list)

Returns true if list contains only nan values

Parameters

checked_list (list) –

Returns

Return type

boolean

yafitss.dataManager module

class yafitss.dataManager.DataManagerImpl(logger: logging.Logger, timer: timer.Timer)

Bases: object

RADECRangeInDegrees(relFITSFilePath) → result.Result

createFITSSliceImage(relFITSFilePath, iFREQ) → result.Result

createFITSSumSliceImage(relFITSFilePath, iFREQ0, iFREQ1) → result.Result

createFits(relFITSFilePath, iRA, iDEC) → result.Result

createSmoothCube(relFITSFilePath, nbox) → result.Result

degToHMSDMS(relFITSFilePath, RAinDD, DECinDD) → result.Result

getAverage(relFITSFilePath, iFREQ0, iFREQ1, iDEC0, iDEC1, iRA0, iRA1) → result.Result

getAverageSpectrum(relFITSFilePath, iDEC0=None, iDEC1=None, iRA0=None, iRA1=None) → result.Result

getContours(relFITSFilePath, iFREQ, iDEC0, iDEC1, iRA0, iRA1, **kwargs) → result.Result

getDataBlockInfos() → result.Result

getDimensions(relFITSFilePath) → result.Result

getEntries(relKey)

getHeader(relFITSFilePath) → result.Result

getOneSliceAsPNG(iFREQ, relFITSFilePath, **kwargs) → result.Result

getPixelValueAtiFreqiRAiDEC(relFITSFilePath: str, iFreq: int, iRA: int, iDEC: int) → result.Result

getPixelValueAtiRAiDEC(relFITSFilePath: str, iRA: int, iDEC: int) → result.Result

getPixelsValueAtiFreqiRAiDEC(relFITSFilePath: str, iPositions) → result.Result

getSlice(relFITSFilePath, iFREQ, step=1) → result.Result

getSpectrum(relFITSFilePath, iRA=None, iDEC=None, iFREQ0=None, iFREQ1=None) → result.Result

getSumOverSliceRectArea(relFITSFilePath, iFREQ, iRA0=None, iRA1=None, iDEC0=None, iDEC1=None) → result.Result

getSummedSliceRangeAsPNG(relFITSFilePath, iFREQ0, iFREQ1, **kwargs) → result.Result

getYtObj(relFITSFilePath, product, coord)

measureBox(relFITSFilePath, iFREQ, iRA0, iRA1, iDEC0, iDEC1) → result.Result

measureContour(relFITSFilePath, iFREQ, contour, level) → result.Result

purgeDataBlocks()

rangeToDMS(relFITSFilePath: str, iDEC0: int, iDEC1: int, iDECstep: int) → result.Result

rangeToHMS(relFITSFilePath, iRA0, iRA1, iRAstep) → result.Result

renderingCapabilities() → result.Result

setData(relFITSFilePath: str)

yafitss.iramColors module

yafitss.log module

class yafitss.log.LogManager

Bases: object

attachRotatingFileHandler(logger: logging.Logger, filePath: str)

Attaches a RotatingFileHandler to the given logger. The output will be written in filePath

Parameters

• logger (logging.Logger) – a Logger object

• filepath (str) – The path of the file where log content will be written

property logBackupCount

property maxLogSize

yafitss.log.getLogger(name: str, filePath: str) → logging.Logger

Returns a Logger object saving data in the file located at filePath and identified as name by a RotatingFileHandler

Parameters

• name (str) – indentifier of logger for the RotatingFileHandler to which it will be attached

• filePath (str) – path where log content will be written

Returns

logging.Logger

Return type

a Logger object instance

yafitss.lutColors module

class yafitss.lutColors.LUT(name)

Bases: object

property colors

getColorMap()

getReverseColorMap()

getReversedColors(colors)

property name

property reversecolors

setColors(colors)

class yafitss.lutColors.LUTIram

Bases: yafitss.lutColors.LUT

lutname = 'iram'

class yafitss.lutColors.LutFactory

Bases: object

getLut(type)

yafitss.pathManager module

yafitss.pathManager.getAbsFITSFilePath(relFITSFilePath)

yafitss.pathManager.getSMOOTHFilePath(relFITSFilePath)

yafitss.result module

class yafitss.result.Result

Bases: object

property message

ok(result: Any) → yafitss.result.Result

property result

property status

toDict() → Dict

toJSON() → str

wrong(message: str) → yafitss.result.Result

yafitss.serverWsgi module

yafitss.serverWsgi.RADECRangeInDegrees(*args, **kwargs)

yafitss.serverWsgi.byteify(input)

A function to transform the content of a dictionary a unicode value into its ascii’s see https://stackoverflow.com/questions/956867/how-to-get-string-objects-instead-of-unicode-from-json

yafitss.serverWsgi.cleanNanInList(arr)

Replaces NaN values by None in array

yafitss.serverWsgi.createFITSSliceImage(*args, **kwargs)

yafitss.serverWsgi.createFITSSumSliceImage(*args, **kwargs)

yafitss.serverWsgi.createFits(*args, **kwargs)

yafitss.serverWsgi.createSmoothCube(*args, **kwargs)

yafitss.serverWsgi.degToHMSDMS(*args, **kwargs)

yafitss.serverWsgi.enable_cors(fn)

enable cross domain ajax requests

yafitss.serverWsgi.getAverage(*args, **kwargs)

yafitss.serverWsgi.getAverageSpectrum(*args, **kwargs)

yafitss.serverWsgi.getBoolValue(value)

yafitss.serverWsgi.getContours(*args, **kwargs)

yafitss.serverWsgi.getDataBlockInfos(*args, **kwargs)

yafitss.serverWsgi.getDimensions(*args, **kwargs)

yafitss.serverWsgi.getEntries(*args, **kwargs)

yafitss.serverWsgi.getFloatValue(value)

yafitss.serverWsgi.getHeader(*args, **kwargs)

yafitss.serverWsgi.getIntValue(value)

yafitss.serverWsgi.getOneSliceAsPNG(*args, **kwargs)

yafitss.serverWsgi.getPixelValueAtiFreqiRAiDEC(*args, **kwargs)

yafitss.serverWsgi.getPixelValueAtiRAiDEC(*args, **kwargs)

yafitss.serverWsgi.getPixelsValueAtiFreqiRAiDEC(*args, **kwargs)

yafitss.serverWsgi.getSlice(*args, **kwargs)

yafitss.serverWsgi.getSpectrum(*args, **kwargs)

yafitss.serverWsgi.getSumOverSliceRectArea(*args, **kwargs)

yafitss.serverWsgi.getSummedSliceRangeAsPNG(*args, **kwargs)

yafitss.serverWsgi.getYtObj(*args, **kwargs)

yafitss.serverWsgi.log_to_logger(fn)

Wrap a Bottle request so that a log line is emitted after it’s handled. (This decorator can be extended to take the desired logger as a param.)

yafitss.serverWsgi.main(argv)

yafitss.serverWsgi.measureBox(*args, **kwargs)

yafitss.serverWsgi.measureContour(*args, **kwargs)

yafitss.serverWsgi.purgeDataBlocks(*args, **kwargs)

yafitss.serverWsgi.rangeToDMS(*args, **kwargs)

yafitss.serverWsgi.rangeToHMS(*args, **kwargs)

yafitss.serverWsgi.rebuildFilename(filename)

Given filename ( string ) returns a string where each space character present in filename is replaced by ‘+’ character.

yafitss.serverWsgi.renderingCapabilities(*args, **kwargs)

yafitss.serverWsgi.saveTest(*args, **kwargs)

yafitss.serverWsgi.send_apidoc(filepath)

yafitss.serverWsgi.send_fits(filepath)

yafitss.serverWsgi.send_png(filepath)

yafitss.serverWsgi.send_spectrum(filepath)

yafitss.serverWsgi.setData(*args, **kwargs)

yafitss.serverWsgi.upAnWaiting(*args, **kwargs)

yafitss.tapquery module

class yafitss.tapquery.NedService

Bases: yafitss.tapquery.TapService

getDefaultParameters()

getDefaultQuery(parameters)

query(adql_query)

class yafitss.tapquery.ServiceFactory

Bases: object

getServices() → set

getTapService(service_name: str) → yafitss.tapquery.TapService

class yafitss.tapquery.TapService

Bases: object

abstract getDefaultParameters()

abstract getDefaultQuery(parameters)

abstract query(adql_query)

yafitss.timer module

class yafitss.timer.Timer(logger)

Bases: object

addComment(message: str, prefix='')

Add a simple comment to the logged content

Parameters

• message (str) – text content that will be added to log content

• prefix (str) – a prefix that will be written before message

start()

Start a new timer

stop(message: str, prefix='')

Stop the timer, and report the elapsed time

Parameters

• message (str) – a message that will be added to the execution time

• prefix (str) – a text that will be used as a prefix before message

exception yafitss.timer.TimerError

Bases: Exception

A custom exception used to report errors in use of Timer class

Module contents