jigl.signal.ops.levelOps
Class Clip

java.lang.Object
  |
  +--jigl.signal.SimpleOperator
        |
        +--jigl.signal.ops.levelOps.Clip

All Implemented Interfaces:

Operator

public class Clip

extends SimpleOperator

Performs a clip operation on a signal to an arbitrary min/max. Supports DiscreteSignal, RealSignal.

Provides command line option.

Field Summary

private float	float_max Upper bound of clip (for RealSignal)
private float	float_min Lower bound of clip (for RealSignal)
private int	int_max Upper bound of clip (for DiscreteSignal)
private int	int_min Lower bound of clip (for DiscreteSignal)

Constructor Summary

Clip(float min, float max)
Initilizes a Clip object for use with floats

Clip(int min, int max)
Initilizes a Clip object for use with integers

Method Summary

protected Signal	apply(DiscreteSignal signal) Clips the range of this signal to an arbitrary min/max.
protected Signal	apply(DiscreteSignal signal, ROI roi) Clips the range of signal to an arbitrary min/max in a region of interest.
protected Signal	apply(RealSignal signal) Clips the range of signal to an arbitrary min/max.
protected Signal	apply(RealSignal signal, ROI roi) Clips the range of signal to an arbitrary min/max in a region of interest.
static void	main(String[] argv) For command line option.

Methods inherited from class jigl.signal.SimpleOperator

apply, apply, apply, apply, apply, apply

Methods inherited from class java.lang.Object

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

Field Detail

int_min

private int int_min

Lower bound of clip (for DiscreteSignal)

int_max

private int int_max

Upper bound of clip (for DiscreteSignal)

float_min

private float float_min

Lower bound of clip (for RealSignal)

float_max

private float float_max

Upper bound of clip (for RealSignal)

Constructor Detail

Clip

public Clip(int min,
            int max)

Initilizes a Clip object for use with integers

Clip

public Clip(float min,
            float max)

Initilizes a Clip object for use with floats

Method Detail

apply

protected Signal apply(DiscreteSignal signal)

Clips the range of this signal to an arbitrary min/max. Returned signal is a DiscreteSignal.

Overrides:

apply in class SimpleOperator

Parameters:

signal - DiscreteSignal

Returns:

DiscreteSignal

apply

protected Signal apply(DiscreteSignal signal,
                       ROI roi)

Clips the range of signal to an arbitrary min/max in a region of interest.

Overrides:

apply in class SimpleOperator

Parameters:

signal - DiscreteSignal

roi - Region of Interest of signal

Returns:

signal

apply

protected Signal apply(RealSignal signal)

Clips the range of signal to an arbitrary min/max.

Overrides:

apply in class SimpleOperator

Parameters:

signal - RealSignal

Returns:

signal

apply

protected Signal apply(RealSignal signal,
                       ROI roi)

Clips the range of signal to an arbitrary min/max in a region of interest.

Overrides:

apply in class SimpleOperator

Parameters:

signal - RealSignal

roi - Region of Interest of signal

Returns:

signal

main

public static void main(String[] argv)

For command line option. The systax is "java Clip min_value max_value input_filename output_filename".