edu.umass.cs.mallet.base.pipe.tsf
Class FeaturesInWindow

java.lang.Object
  extended byedu.umass.cs.mallet.base.pipe.Pipe
      extended byedu.umass.cs.mallet.base.pipe.tsf.FeaturesInWindow
All Implemented Interfaces:
java.io.Serializable

public class FeaturesInWindow
extends Pipe
implements java.io.Serializable

See Also:
Serialized Form

Constructor Summary
FeaturesInWindow(java.lang.String namePrefix, int leftBoundaryOffset, int rightBoundaryOffset)
          equivalent to
FeaturesInWindow((namePrefix, leftBoundaryOffset, rightBoundaryOffset, null, true);
FeaturesInWindow(java.lang.String namePrefix, int leftBoundaryOffset, int rightBoundaryOffset, java.util.regex.Pattern featureRegex, boolean includeBeginEndBoundaries)
           
 
Method Summary
 Instance pipe(Instance carrier)
          Process an Instance.
 
Methods inherited from class edu.umass.cs.mallet.base.pipe.Pipe
getDataAlphabet, getInstanceId, getParent, getParentRoot, getTargetAlphabet, isDataAlphabetSet, isTargetProcessing, pipe, readResolve, resolveDataAlphabet, resolveTargetAlphabet, setDataAlphabet, setParent, setTargetAlphabet, setTargetProcessing
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FeaturesInWindow

public FeaturesInWindow(java.lang.String namePrefix,
                        int leftBoundaryOffset,
                        int rightBoundaryOffset,
                        java.util.regex.Pattern featureRegex,
                        boolean includeBeginEndBoundaries)
Parameters:
namePrefix - what to prepend to feature names
leftBoundaryOffset - left boundary of the window (e.g. -1 means include the previous word
rightBoundaryOffset - right boundary for this window (e.g. 1 means include the current position, but not the next
featureRegex - add only for features matching this (null = always match
includeBeginEndBoundaries - ignored

FeaturesInWindow

public FeaturesInWindow(java.lang.String namePrefix,
                        int leftBoundaryOffset,
                        int rightBoundaryOffset)
equivalent to
FeaturesInWindow((namePrefix, leftBoundaryOffset, rightBoundaryOffset, null, true);

Method Detail

pipe

public Instance pipe(Instance carrier)
Description copied from class: Pipe
Process an Instance. This method takes an input Instance, destructively modifies it in some way, and returns it. This is the method by which all pipes are eventually run.

One can create a new concrete subclass of Pipe simply by implementing this method.

Specified by:
pipe in class Pipe
Parameters:
carrier - Instance to be processed.