TimeStackGanger (Starjava TTOOLS API)

java.lang.Object
- uk.ac.starlink.ttools.plot2.geom.StackGanger<TimeSurfaceFactory.Profile,TimeAspect>
- - uk.ac.starlink.ttools.plot2.geom.TimeStackGanger

All Implemented Interfaces:

Ganger<TimeSurfaceFactory.Profile,TimeAspect>
```
public class TimeStackGanger
extends StackGanger<TimeSurfaceFactory.Profile,TimeAspect>
```
Ganger that stacks time plots vertically with a shared time axis.

Since:

3 Feb 2016

Author:

Mark Taylor

Field Summary

Fields
Modifier and Type Field Description

static GangerFactory FACTORY
GangerFactory instance that returns TimeStackGangers.

Fields
Modifier and Type	Field	Description
`static GangerFactory`	`FACTORY`	GangerFactory instance that returns TimeStackGangers.

Constructor Summary

Constructors
Constructor Description

TimeStackGanger(Padding padding)
Constructor.

Constructors
Constructor	Description
`TimeStackGanger(Padding padding)`	Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`TimeSurfaceFactory.Profile[]`	`adjustProfiles(TimeSurfaceFactory.Profile[] profiles)`	Adjusts plot surface profiles as required for plots appearing in multiple plots within a gang.
`TimeAspect`	`fixXLimits(TimeAspect aspect, double xmin, double xmax)`	Modifies an aspect object to give it fixed data limits on the horizontal axis.
`double[]`	`getXLimits(TimeAspect aspect)`	Returns the data limits of the horizontal axis defined by a given aspect.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from class uk.ac.starlink.ttools.plot2.geom.StackGanger
adjustAspects, createApproxGang, createGang, createGang

- Field Detail
  - FACTORY
```
public static final GangerFactory FACTORY
```
    GangerFactory instance that returns TimeStackGangers.
- Constructor Detail
  - TimeStackGanger
```
public TimeStackGanger(Padding padding)
```
    Constructor.
    
    Parameters:
    
    padding - defines user preferences, if any, for space reserved outside each plot zone
- Method Detail
  - getXLimits
```
public double[] getXLimits(TimeAspect aspect)
```
    Description copied from class: StackGanger
    
    Returns the data limits of the horizontal axis defined by a given aspect.
    
    Specified by:
    
    getXLimits in class StackGanger<TimeSurfaceFactory.Profile,TimeAspect>
    
    Parameters:
    
    aspect - surface aspect
    
    Returns:
    
    2-element array giving (min,max) values of data coordinates on the horizontal axis
  - fixXLimits
```
public TimeAspect fixXLimits(TimeAspect aspect,
                             double xmin,
                             double xmax)
```
    Description copied from class: StackGanger
    
    Modifies an aspect object to give it fixed data limits on the horizontal axis.
    
    Specified by:
    
    fixXLimits in class StackGanger<TimeSurfaceFactory.Profile,TimeAspect>
    
    Parameters:
    
    aspect - input surface aspect
    
    xmin - required lower limit on horizontal axis
    
    xmax - required upper limit on horizontal axis
    
    Returns:
    
    new aspect resembling input aspect but with supplied horizontal axis limits
  - adjustProfiles
```
public TimeSurfaceFactory.Profile[] adjustProfiles(TimeSurfaceFactory.Profile[] profiles)
```
    Description copied from interface: Ganger
    
    Adjusts plot surface profiles as required for plots appearing in multiple plots within a gang.
    
    Specified by:
    
    adjustProfiles in interface Ganger<TimeSurfaceFactory.Profile,TimeAspect>
    
    Overrides:
    
    adjustProfiles in class StackGanger<TimeSurfaceFactory.Profile,TimeAspect>
    
    Parameters:
    
    profiles - unadjusted profiles
    
    Returns:
    
    array of consistent profiles based on input array, same size as input

Class TimeStackGanger

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from class uk.ac.starlink.ttools.plot2.geom.StackGanger

Field Detail

FACTORY

Constructor Detail

TimeStackGanger

Method Detail

getXLimits

fixXLimits

adjustProfiles