uk.ac.starlink.ttools.plot2.layer

Class GridSpec

java.lang.Object

uk.ac.starlink.ttools.plot2.layer.GridSpec

public class GridSpec
extends Object

Specifies bin geometry for a 1-dimensional grid.

Since:

24 Apr 2026

Author:

Mark Taylor

Constructor Summary

Constructors

Constructor and Description
GridSpec(Scale scale, double binWidth, double phase, double[] drange) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	contains(GridSpec other) Indicates whether this specification is a superset of the given one.
boolean	containsBin(int ibin) Tests whether a given bin index falls within this grid's bounds.
boolean	containsDataPoint(double d) Tests whether a given value in data coordinates falls within this grid's bounds.
int	getBinCount() Returns the number of bins corresponding to the data extent of this grid.
int	getBinOffset(int ibin) Returns the offset index for a given bin.
int[]	getBinRange(double[] dataRange) Returns the range of bin indices corresponding to a range in data coordinates for this grid.
double	getBinWidth() Returns the bin width in scale units.
BinMapper	getMapper() Returns the mapper from axis data values to bin indices.
Scale	getScale() Returns the axis scaling.
boolean	nearlyContainsBin(int ibin) Tests whether a given bin index either falls within this grid's bounds or is just outside them.

Methods inherited from class java.lang.Object

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

Constructor Detail

GridSpec

public GridSpec(Scale scale,
                double binWidth,
                double phase,
                double[] drange)

Constructor.

Parameters:

scale - axis scale

binWidth - bin width in scale units

phase - scaled phase (non-degenerate range is 0..1)

drange - 2-element [lo,hi] array giving required minimum extent in data coordinates

Method Detail

getScale

public Scale getScale()

Returns the axis scaling.

Returns:

scale

getBinWidth

public double getBinWidth()

Returns the bin width in scale units.

Returns:

bin width

getBinCount

public int getBinCount()

Returns the number of bins corresponding to the data extent of this grid.

Returns:

bin count

getMapper

public BinMapper getMapper()

Returns the mapper from axis data values to bin indices.

Returns:

bin mapper

contains

public boolean contains(GridSpec other)

Indicates whether this specification is a superset of the given one.

Parameters:

other - comparison object

Returns:

true iff this object contains all the information contained by other

containsDataPoint

public boolean containsDataPoint(double d)

Tests whether a given value in data coordinates falls within this grid's bounds.

Parameters:

d - test data point

Returns:

true iff d falls within the grid bounds of this object

containsBin

public boolean containsBin(int ibin)

Tests whether a given bin index falls within this grid's bounds.

Parameters:

ibin - test bin index

Returns:

true iff ibin identifies one of this grid's bins

nearlyContainsBin

public boolean nearlyContainsBin(int ibin)

Tests whether a given bin index either falls within this grid's bounds or is just outside them.

Parameters:

ibin - bin index

Returns:

true iff ibin is no more than one away from this grid

getBinOffset

public int getBinOffset(int ibin)

Returns the offset index for a given bin.

Parameters:

ibin - bin index as returned by the mapper

Returns:

offset bin index in the range 0..(ihi_-ilo_)

getBinRange

public int[] getBinRange(double[] dataRange)

Returns the range of bin indices corresponding to a range in data coordinates for this grid.

Parameters:

dataRange - 2-element array (lo,hi) of data values

Returns:

2-element array (lo,hi) of bin indices