net.sf.jaer.eventprocessing
Class EventFilter2D

java.lang.Object
  net.sf.jaer.eventprocessing.EventFilter
      net.sf.jaer.eventprocessing.EventFilter2D

Direct Known Subclasses:

ANFSpikeBuffer, AuditoryReflex, BackgroundActivityFilter, BallShooter, BallShooterCochlea, Batter, BillCatcher, BoredomFilter, CalibratedPanTilt, ChannelFilter, CircularConvolutionFilter, ClusterTracker, CochleaCrossCorrelator, CochleaEventRate, CochleaExtractorFilter, CochleaPitchExtractor, CochleaXCorrelator, ControlFilter, CorrelatorFilter, CUDAObjectTrackerControl, DecayFilter, DirectionSelectiveFilter, DisparityFilter, DollBrainFPNfilter, Driver, Driver.DriverPreFilter, EllipseTracker, EpilolarLineMonitor, EpipolarRectification, EventTimingMonitor, ExampleFilter, EyeFilter, EyeTracker, FaceTrack, FancyDriver, GestureTracker, GlobalDisparityFilter, GlobalDisparityFilter2, Goalie, GoalieTableFilter, GravityCentersImageDumper, HarmonicFilter, HeadTracker, HingeLaneTracker, HingeLineTracker, HmmFilter, HoughEyeTracker, HoughLineTracker, Info, KalmanFilter, LEDTracker, MedianTracker, MotionCompensator, MSO, MultiLineClusterTracker, MultipleXYTypeFilter, NearestEventMotionComputer, OnOffProximityLineFilter, OrientationCluster, OverlappingSubSampler, PanTiltTracker, ParticleTracker, PawTracker, PawTracker2, PawTracker3, PawTrackerStereoBoard, PawTrackerStereoBoard2, PawTrackerStereoBoard3, PawTrackerStereoBoard4, PawTrackerStereoBoard5, PawTrackerStereoBoard6, PencilBalancer, PerspecTransform, ProbFPNCorrectionFilter, RectangularClusterTracker, RefractoryFilter, RepetitiousFilter, RetinaExtractorFilter, RoboQuadSocialSonar, RotateFilter, RotateRetinaFilter, ServoArm, ServoReaction, ShiftByEventsFilter, SimpleOrientationFilter, SpatialBandpassFilter, SpikeSoundFilter, StereoDisplay, StereoEpilolarLineMonitor, StereoEventTimingMonitor, StereoTranslateRotate, StereoVergenceFilter, SubSampler, SubSamplingBandpassFilter, TemplateTracker, Tmpdiff128RateController, TopologyTracker, TypeCoincidenceFilter, WingTracker, XYCenterOutFilter, XYTypeFilter, ZipZapTrackFollower

public abstract class EventFilter2D
extends EventFilter

A filter that filters or otherwise processes a packet of events.

Author:

tobi

Field Summary

protected EventFilter2D	enclosedFilter overrides EventFilter type in EventFilter
protected EventPacket	out The built-in reference to the output packet

Fields inherited from class net.sf.jaer.eventprocessing.EventFilter

annotationEnabled, chip, enclosedFilterChain, filterEnabled, log, perf, propertyTooltipMap, support

Constructor Summary

EventFilter2D(AEChip chip)
Subclasses should call this super initializer

Method Summary

protected void	checkOutputPacketEventType(java.lang.Class<? extends BasicEvent> outClass) checks out packet to make sure it is the same type as the given class.
protected void	checkOutputPacketEventType(EventPacket in) checks out packet to make sure it is the same type as the input packet.
abstract EventPacket<?>	filterPacket(EventPacket<?> in) Subclasses implement this method to define custom processing.
EventFilter2D	getEnclosedFilter() A filter can enclose another filter and can access and process this filter.
protected void	resetOut() Resets the output packet to be a new packet if none has been instanced or clears the packet if it exists
void	setEnclosedFilter(EventFilter2D enclosedFilter) A filter can enclose another filter and can access and process this filter.
void	setFilterEnabled(boolean yes) Resets the filter

Methods inherited from class net.sf.jaer.eventprocessing.EventFilter

getChip, getDescription, getEnclosedFilterChain, getEnclosingFilter, getFilterState, getPrefs, getPropertyChangeSupport, getPropertyTooltip, initFilter, isAnnotationEnabled, isEnclosed, isFilterEnabled, prefsEnabledKey, resetFilter, setAnnotationEnabled, setChip, setEnclosed, setEnclosedFilter, setEnclosedFilterChain, setEnclosingFilter, setPreferredEnabledState, setPrefs, setPropertyTooltip

Methods inherited from class java.lang.Object

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

Field Detail

out

protected EventPacket out

The built-in reference to the output packet

enclosedFilter

protected EventFilter2D enclosedFilter

overrides EventFilter type in EventFilter

Constructor Detail

EventFilter2D

public EventFilter2D(AEChip chip)

Subclasses should call this super initializer

Method Detail

resetOut

protected void resetOut()

Resets the output packet to be a new packet if none has been instanced or clears the packet if it exists

checkOutputPacketEventType

protected void checkOutputPacketEventType(EventPacket in)

checks out packet to make sure it is the same type as the input packet. This method is used for filters that must pass output that has same event type as input.

Parameters:

in - the input packet

See Also:

out

checkOutputPacketEventType

protected void checkOutputPacketEventType(java.lang.Class<? extends BasicEvent> outClass)

checks out packet to make sure it is the same type as the given class. This method is used for filters that must pass output that has a particular output type.

Parameters:

outClass - the output packet.

filterPacket

public abstract EventPacket<?> filterPacket(EventPacket<?> in)

Subclasses implement this method to define custom processing.

Parameters:

in - the input packet

Returns:

the output packet

getEnclosedFilter

public EventFilter2D getEnclosedFilter()

A filter can enclose another filter and can access and process this filter. Note that this processing is not automatic. Enclosing a filter inside another filter means that it will be built into the GUI as such

Overrides:

getEnclosedFilter in class EventFilter

Returns:

the enclosed filter

setEnclosedFilter

public void setEnclosedFilter(EventFilter2D enclosedFilter)

A filter can enclose another filter and can access and process this filter. Note that this processing is not automatic. Enclosing a filter inside another filter means that it will be built into the GUI as such.

Parameters:

enclosedFilter - the enclosed filter

setFilterEnabled

public void setFilterEnabled(boolean yes)

Resets the filter

Overrides:

setFilterEnabled in class EventFilter

Parameters:

yes - true to reset

See Also:

EventFilter.setPreferredEnabledState()