uk.ac.starlink.ttools.task
Class PixSample

java.lang.Object
  extended by uk.ac.starlink.ttools.task.ConsumerTask
      extended by uk.ac.starlink.ttools.task.MapperTask
          extended by uk.ac.starlink.ttools.task.PixSample
All Implemented Interfaces:
Task

public class PixSample
extends MapperTask

Samples data from a HEALPix pixel file.

Since:
6 Dec 2011
Author:
Mark Taylor

Nested Class Summary
static interface PixSample.CoordReader
          Interface to turn input coordinate values into coordinate values suitable for pixel sampling.
 
Constructor Summary
PixSample()
          Constructor.
 
Method Summary
static PixSample.CoordReader createCoordReader(SkySystem inSys, SkySystem outSys)
          Returns a coordinate reader which converts between a given input and output coordinate system.
static ColumnSupplement createSampleSupplement(StarTable base, PixSampler pixSampler, PixSampler.StatMode statMode, PixSample.CoordReader coordReader, String lonExpr, String latExpr, String radExpr)
          Creates a table containing pixel samples corresponding to the rows of a base table in accordance with supplied parameters.
 
Methods inherited from class uk.ac.starlink.ttools.task.MapperTask
createProducer, getMapper, getTablesInput
 
Methods inherited from class uk.ac.starlink.ttools.task.ConsumerTask
createExecutable, createProducer, getOutputMode, getParameterList, getParameters, getPurpose
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PixSample

public PixSample()
Constructor.

Method Detail

createSampleSupplement

public static ColumnSupplement createSampleSupplement(StarTable base,
                                                      PixSampler pixSampler,
                                                      PixSampler.StatMode statMode,
                                                      PixSample.CoordReader coordReader,
                                                      String lonExpr,
                                                      String latExpr,
                                                      String radExpr)
                                               throws IOException
Creates a table containing pixel samples corresponding to the rows of a base table in accordance with supplied parameters.

Parameters:
base - base table
pixSampler - characterises pixel sampling
coordReader - turns input coordinate pairs into lon/lat coords in the HEALPix coordinate system
lonExpr - JEL expression for first input coordinate
latExpr - JEL expression for second input coordinate
radExpr - JEL expression for averaging radius
Returns:
table containing sampled columns
Throws:
IOException

createCoordReader

public static PixSample.CoordReader createCoordReader(SkySystem inSys,
                                                      SkySystem outSys)
Returns a coordinate reader which converts between a given input and output coordinate system. If no conversion is required, use null for in/out systems.

Parameters:
inSys - input sky coordinate system
outSys - output sky coordinate system
Returns:
coordinate reader that converts


Copyright © 2015 Central Laboratory of the Research Councils. All Rights Reserved.