uk.ac.starlink.ttools.plot2.layer

Class GridPixer

java.lang.Object

uk.ac.starlink.ttools.plot2.layer.GridPixer

public class GridPixer
extends Object

Defines the mapping of coordinates in a bounded region of a 2-d data space to a single bin index.

Since:

24 Apr 2026

Author:

Mark Taylor

Constructor Summary

Constructors

Constructor and Description
GridPixer(GridSpec xgrid, GridSpec ygrid) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	contains(GridPixer other) Indicates whether this pixer is a superset of the given pixer.
int	getBinCount() Returns the number of bins covered by this grid.
double	getBinFactor(Combiner.Type ctype) Returns the area of a bin in data units.
int	getBinIndex(double[] dpos) Calculates the grid index for a given position in data space.
int	getBinIndex(int ix, int iy) Returns the grid index given the X and Y grid indices.
GridSpec	getGridX() Returns the 1-d grid specification in the X direction.
GridSpec	getGridY() Returns the 1-d grid specification in the Y direction.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GridPixer

public GridPixer(GridSpec xgrid,
                 GridSpec ygrid)

Constructor.

Parameters:

xgrid - 1-d grid specification in X direction

ygrid - 1-d grid specification in Y direction

Method Detail

getGridX

public GridSpec getGridX()

Returns the 1-d grid specification in the X direction.

Returns:

X grid spec

getGridY

public GridSpec getGridY()

Returns the 1-d grid specification in the Y direction.

Returns:

Y grid spec

getBinCount

public int getBinCount()

Returns the number of bins covered by this grid.

Returns:

bin count

getBinIndex

public int getBinIndex(double[] dpos)

Calculates the grid index for a given position in data space.

Parameters:

dpos - position in data coordinates

Returns:

grid index, or negative number if off-grid

getBinIndex

public int getBinIndex(int ix,
                       int iy)

Returns the grid index given the X and Y grid indices.

Parameters:

ix - X gridder bin index

iy - Y gridder bin index

Returns:

grid index for bin list, or negative number if off-grid

getBinFactor

public double getBinFactor(Combiner.Type ctype)

Returns the area of a bin in data units. If either axis is non-linear, this will be a strange quantity.

Parameters:

ctype - combination type

Returns:

multiplication for bin values

contains

public boolean contains(GridPixer other)

Indicates whether this pixer is a superset of the given pixer.

Parameters:

other - comparison object

Returns:

true iff this object contains all the information contained by other