Class ProcessWithPraat
- java.lang.Object
-
- java.lang.Thread
-
- nzilbb.labbcat.server.task.Task
-
- nzilbb.labbcat.server.task.ProcessWithPraat
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class java.lang.Thread
Thread.State, Thread.UncaughtExceptionHandler
-
-
Field Summary
-
Fields inherited from class java.lang.Thread
MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY
-
-
Constructor Summary
Constructors Constructor Description ProcessWithPraat()Default constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddAttributes(String[] attributes)Adds an array of attribute names toattributes.voidcancel()Cancels the task.StringdescriptiveName()Generates a descriptive name for the processing.booleanfilesAccessed()Determines whether the user-customizable parts of the Praat script include operations for reading/writing files.voidgenerateScript(PrintWriter scriptWriter, File tempDirectory, File wav, Vector<Vector<Double>> targets, Integer formantCeiling, Integer pitchFloor, Integer pitchCeiling, Double voicingThreshold, Integer intensityPitchFloor, Integer fastTrackLowestAnalysisFrequency, Integer fastTrackHighestAnalysisFrequency, HashMap<String,String> attributeValues)Extracts the formants at the given times for the given WAV fileHashSet<String>getAttributes()Getter forattributes: Attributes to make available to custom script.StringgetCustomScript()Getter forcustomScript: Custom script specified by the user to execute on each sample.Vector<String>getCustomScriptHeaders()Getter forcustomScriptHeaders: Headers for custom script outputs.FilegetDataFile()Getter fordataFile: CSV data filebooleangetExtractCOG1()Getter forextractCOG1: Whether to extract the centre of gravity, with p = 1.booleangetExtractCOG2()Getter forextractCOG2: Whether to extract the centre of gravity, with p = 2.booleangetExtractCOG23()Getter forextractCOG23: Whether to extract the centre of gravity, with p = 2/3.booleangetExtractF1()Getter forextractF1: Whether to extract F1booleangetExtractF2()Getter forextractF2: Whether to extract F2booleangetExtractF3()Getter forextractF3: Whether to extract F3booleangetExtractMaximumIntensity()Getter forextractMaximumIntensity: Whether to extract the maximum intensitybooleangetExtractMaximumPitch()Getter forextractMaximumPitch: Whether to extract the maximum pitchbooleangetExtractMeanPitch()Getter forextractMeanPitch: Whether to extract the mean pitchbooleangetExtractMinimumPitch()Getter forextractMinimumPitch: Whether to extract the minimum pitchStringgetFastTrackBasisFunctions()Getter forfastTrackBasisFunctions: Fast Track basis_functions global setting.booleangetFastTrackCoefficients()Getter forfastTrackCoefficients: Whether to return the regression coefficients from FastTrack.StringgetFastTrackDifferentiationLayerId()Getter forfastTrackDifferentiationLayerId: Participant attribute layer ID for differentiating fastTrack settings.booleangetFastTrackEnableF1BandwidthHeuristic()Getter forfastTrackEnableF1BandwidthHeuristic: Fast Track enable_F1_bandwidth_heuristic global setting.booleangetFastTrackEnableF1FrequencyHeuristic()Getter forfastTrackEnableF1FrequencyHeuristic: Fast Track enable_F1_frequency_heuristic global setting.booleangetFastTrackEnableF2BandwidthHeuristic()Getter forfastTrackEnableF2BandwidthHeuristic: Fast Track enable_F2_bandwidth_heuristic global setting.booleangetFastTrackEnableF3BandwidthHeuristic()Getter forfastTrackEnableF3BandwidthHeuristic: Fast Track enable_F3_bandwidth_heuristic global setting.booleangetFastTrackEnableF3F4ProximityHeuristic()Getter forfastTrackEnableF3F4ProximityHeuristic: Fast Track enable_F3F4_proximity_heuristic global setting.booleangetFastTrackEnableF4FrequencyHeuristic()Getter forfastTrackEnableF4FrequencyHeuristic: Fast Track enable_F4_frequency_heuristic global setting.booleangetFastTrackEnableRhoticHeuristic()Getter forfastTrackEnableRhoticHeuristic: Fast Track enable_rhotic_heuristic global setting.StringgetFastTrackErrorMethod()Getter forfastTrackErrorMethod: Fast Track error_method global setting.intgetFastTrackHighestAnalysisFrequencyDefault()Getter forfastTrackHighestAnalysisFrequencyDefault: Fast Track highest analysis frequency by default.Vector<Integer>getFastTrackHighestAnalysisFrequencyOther()Getter forfastTrackHighestAnalysisFrequencyOther: Values to use as the Fast Track highest analysis frequency for participants who's attribute value matches the corresponding regular expression informantOtherPattern.intgetFastTrackLowestAnalysisFrequencyDefault()Getter forfastTrackLowestAnalysisFrequencyDefault: Fast Track lowest analysis frequency by default.Vector<Integer>getFastTrackLowestAnalysisFrequencyOther()Getter forfastTrackLowestAnalysisFrequencyOther: Values to use as the Fast Track lowest analysis frequency for participants who's attribute value matches the corresponding regular expression infastTrackOtherPattern.intgetFastTrackMaximumF1BandwidthValue()Getter forfastTrackMaximumF1BandwidthValue: Fast Track maximum_F1_bandwidth_value global setting.intgetFastTrackMaximumF1FrequencyValue()Getter forfastTrackMaximumF1FrequencyValue: Fast Track maximum_F1_frequency_value global setting.intgetFastTrackMaximumF2BandwidthValue()Getter forfastTrackMaximumF2BandwidthValue: Fast Track maximum_F2_bandwidth_value global setting.intgetFastTrackMaximumF3BandwidthValue()Getter forfastTrackMaximumF3BandwidthValue: Fast Track maximum_F3_bandwidth_value global setting.doublegetFastTrackMinimumDuration()Getter forfastTrackMinimumDuration: Minimum duration of a segment for FastTrack analysis.intgetFastTrackMinimumF4FrequencyValue()Getter forfastTrackMinimumF4FrequencyValue: Fast Track minimum_F4_frequency_value global setting.intgetFastTrackNumberOfCoefficients()Getter forfastTrackNumberOfCoefficients: Fast Track number of coefficients for the regression function.intgetFastTrackNumberOfFormants()Getter forfastTrackNumberOfFormants: Fast Track number of formants.intgetFastTrackNumberOfSteps()Getter forfastTrackNumberOfSteps: Fast Track number of steps.Vector<Pattern>getFastTrackOtherPattern()Getter forfastTrackOtherPattern: List of regular expression strings to match against the value of that attribute identified byfastTrackDifferentiationLayerId.doublegetFastTrackTimeStep()Getter forfastTrackTimeStep: Fast Track time_step global setting - time step in seconds.StringgetFastTrackTrackingMethod()Getter forfastTrackTrackingMethod: Fast Track tracking_method parameter for trackAutoselectProcedure; "burg" or "robust".chargetFieldDelimiter()Getter forfieldDelimiter: The field delimiter character for the CSV file.StringgetFileName()Getter forfileName: Name to use as the basis for an output file nameintgetFormantCeilingDefault()Getter forformantCeilingDefault: Formant ceiling by default.Vector<Integer>getFormantCeilingOther()Getter forformantCeilingOther: Values to use as the formant ceiling for participants who's attribute value matches the corresponding regular expression informantOtherPattern.StringgetFormantDifferentiationLayerId()Getter forformantDifferentiationLayerId: Participant attribute layer ID for differentiating formant settings.Vector<Pattern>getFormantOtherPattern()Getter forformantOtherPattern: List of regular expression strings to match against the value of that attribute identified byformantDifferentiationLayerId.StringgetIntensityDifferentiationLayerId()Getter forintensityDifferentiationLayerId: Participant attribute layer ID for differentiating intensity settings.Vector<Pattern>getIntensityOtherPattern()Getter forintensityOtherPattern: List of regular expression strings to match against the value of that attribute identified byintensityDifferentiationLayerId.intgetIntensityPitchFloorDefault()Getter forintensityPitchFloorDefault: Intensity Pitch Floor by default.Vector<Integer>getIntensityPitchFloorOther()Getter forintensityPitchFloorOther: Values to use as the intensity pitch floor for participants who's attribute value matches the corresponding regular expression inintensityOtherPattern.intgetMarkColumn()Getter formarkColumn: Column that identifies the time, or start time if an end column is specified, at which the formant should be evaluated.IntegergetMarkEndColumn()Getter formarkEndColumn: Column that identifies the end time of the span for which formants should be evaluated.intgetParticipantNameColumn()Getter forparticipantNameColumn: The index of the column that specifies the name of the speaker.booleangetPassThroughData()Getter forpassThroughData: Whether to pass data in the original CSV file to the output.IntegergetPercentComplete()Determines how far through the task is.intgetPitchCeilingDefault()Getter forpitchCeilingDefault: Pitch Ceiling by default.Vector<Integer>getPitchCeilingOther()Getter forpitchCeilingOther: Values to use as the pitch ceiling for participants who's attribute value matches the corresponding regular expression inpitchOtherPattern.StringgetPitchDifferentiationLayerId()Getter forpitchDifferentiationLayerId: Participant attribute layer ID for differentiating pitch settings.intgetPitchFloorDefault()Getter forpitchFloorDefault: Pitch Floor by default.Vector<Integer>getPitchFloorOther()Getter forpitchFloorOther: Values to use as the pitch floor for participants who's attribute value matches the corresponding regular expression inpitchOtherPattern.Vector<Pattern>getPitchOtherPattern()Getter forpitchOtherPattern: List of regular expression strings to match against the value of that attribute identified bypitchDifferentiationLayerId.Vector<Double>getSamplePoints()Getter forsamplePoints: List of positions in the segment to take values - 0.0 = at the beginning of the intervale, 1.0 = at the end of the interval, 0.5 in the middle, etc.StringgetScriptFormant()Getter forscriptFormant: Command to send to Praat for creating a formant track.StringgetScriptIntensity()Getter forscriptIntensity: Command to send to Praat for creating an intensity track.StringgetScriptPitch()Getter forscriptPitch: Command to send to Praat for creating a pitch track.StringgetScriptSpectrum()Getter forscriptSpectrum: Command to send to Praat for creating a spectrum object.IntegergetSimultaneousThreadCount()Getter forsimultaneousThreadCount: Number of Praat scripts to run in parallel.intgetTranscriptIdColumn()Getter fortranscriptIdColumn: Colum that contains the transcript_idbooleangetUseFastTrack()Getter foruseFastTrack: Use the FastTrack plugin to generate optimum, smoothed formant tracks.doublegetVoicingThresholdDefault()Getter forvoicingThresholdDefault: Voicing Threshold by default.Vector<Double>getVoicingThresholdOther()Getter forvoicingThresholdOther: Values to use as the voicing threshold for participants who's attribute value matches the corresponding regular expression inpitchOtherPattern.doublegetWindowOffset()Getter forwindowOffset: How long before in seconds before the start and after the end times to take as a sample window.FutureTask<File>processBatch(String transcript, String speaker, PreparedStatement sqlSpeakerAttribute, Vector<org.apache.commons.csv.CSVRecord> batch, org.apache.commons.csv.CSVFormat format)Create a Callable that will process a list of lines, all from the same transcript file.voidrun()Run the task.ProcessWithPraatsetCustomScript(String newCustomScript)Setter forcustomScript: Custom script specified by the user to execute on each sample.ProcessWithPraatsetCustomScriptHeaders(Vector<String> newCustomScriptHeaders)Setter forcustomScriptHeaders: Headers for custom script outputs.ProcessWithPraatsetDataFile(File fNewDataFile)Setter fordataFile: CSV data file, which will be deleted after processing.ProcessWithPraatsetExtractCOG1(boolean newExtractCOG1)Setter forextractCOG1: Whether to extract the centre of gravity, with p = 1.ProcessWithPraatsetExtractCOG2(boolean newExtractCOG2)Setter forextractCOG2: Whether to extract the centre of gravity, with p = 2.ProcessWithPraatsetExtractCOG23(boolean newExtractCOG23)Setter forextractCOG23: Whether to extract the centre of gravity, with p = 2/3.ProcessWithPraatsetExtractF1(boolean bNewExtractF1)Setter forextractF1: Whether to extract F1ProcessWithPraatsetExtractF2(boolean bNewExtractF2)Setter forextractF2: Whether to extract F2ProcessWithPraatsetExtractF3(boolean bNewExtractF3)Setter forextractF3: Whether to extract F3ProcessWithPraatsetExtractMaximumIntensity(boolean bNewExtractMaximumIntensity)Setter forextractMaximumIntensity: Whether to extract the maximum intensityProcessWithPraatsetExtractMaximumPitch(boolean bNewExtractMaximumPitch)Setter forextractMaximumPitch: Whether to extract the maximum pitchProcessWithPraatsetExtractMeanPitch(boolean bNewExtractMeanPitch)Setter forextractMeanPitch: Whether to extract the mean pitchProcessWithPraatsetExtractMinimumPitch(boolean bNewExtractMinimumPitch)Setter forextractMinimumPitch: Whether to extract the minimum pitchProcessWithPraatsetFastTrackBasisFunctions(String newFastTrackBasisFunctions)Setter forfastTrackBasisFunctions: Fast Track basis_functions global setting.ProcessWithPraatsetFastTrackCoefficients(boolean newFastTrackCoefficients)Setter forfastTrackCoefficients: Whether to return the regression coefficients from FastTrack.ProcessWithPraatsetFastTrackDifferentiationLayerId(String newFastTrackDifferentiationLayerId)Setter forfastTrackDifferentiationLayerId: Participant attribute layer ID for differentiating fastTrack settings.ProcessWithPraatsetFastTrackEnableF1BandwidthHeuristic(boolean newFastTrackEnableF1BandwidthHeuristic)Setter forfastTrackEnableF1BandwidthHeuristic: Fast Track enable_F1_bandwidth_heuristic global setting.ProcessWithPraatsetFastTrackEnableF1FrequencyHeuristic(boolean newFastTrackEnableF1FrequencyHeuristic)Setter forfastTrackEnableF1FrequencyHeuristic: Fast Track enable_F1_frequency_heuristic global setting.ProcessWithPraatsetFastTrackEnableF2BandwidthHeuristic(boolean newFastTrackEnableF2BandwidthHeuristic)Setter forfastTrackEnableF2BandwidthHeuristic: Fast Track enable_F2_bandwidth_heuristic global setting.ProcessWithPraatsetFastTrackEnableF3BandwidthHeuristic(boolean newFastTrackEnableF3BandwidthHeuristic)Setter forfastTrackEnableF3BandwidthHeuristic: Fast Track enable_F3_bandwidth_heuristic global setting.ProcessWithPraatsetFastTrackEnableF3F4ProximityHeuristic(boolean newFastTrackEnableF3F4ProximityHeuristic)Setter forfastTrackEnableF3F4ProximityHeuristic: Fast Track enable_F3F4_proximity_heuristic global setting.ProcessWithPraatsetFastTrackEnableF4FrequencyHeuristic(boolean newFastTrackEnableF4FrequencyHeuristic)Setter forfastTrackEnableF4FrequencyHeuristic: Fast Track enable_F4_frequency_heuristic global setting.ProcessWithPraatsetFastTrackEnableRhoticHeuristic(boolean newFastTrackEnableRhoticHeuristic)Setter forfastTrackEnableRhoticHeuristic: Fast Track enable_rhotic_heuristic global setting.ProcessWithPraatsetFastTrackErrorMethod(String newFastTrackErrorMethod)Setter forfastTrackErrorMethod: Fast Track error_method global setting.ProcessWithPraatsetFastTrackHighestAnalysisFrequencyDefault(int newFastTrackHighestAnalysisFrequencyDefault)Setter forfastTrackHighestAnalysisFrequencyDefault: Fast Track highest analysis frequency by default.ProcessWithPraatsetFastTrackHighestAnalysisFrequencyOther(Vector<Integer> newFastTrackHighestAnalysisFrequencyOther)Setter forfastTrackHighestAnalysisFrequencyOther: Values to use as the Fast Track highest analysis frequency for participants who's attribute value matches the corresponding regular expression informantOtherPattern.ProcessWithPraatsetFastTrackLowestAnalysisFrequencyDefault(int newFastTrackLowestAnalysisFrequencyDefault)Setter forfastTrackLowestAnalysisFrequencyDefault: Fast Track lowest analysis frequency by default.ProcessWithPraatsetFastTrackLowestAnalysisFrequencyOther(Vector<Integer> newFastTrackLowestAnalysisFrequencyOther)Setter forfastTrackLowestAnalysisFrequencyOther: Values to use as the Fast Track lowest analysis frequency for participants who's attribute value matches the corresponding regular expression infastTrackOtherPattern.ProcessWithPraatsetFastTrackMaximumF1BandwidthValue(int newFastTrackMaximumF1BandwidthValue)Setter forfastTrackMaximumF1BandwidthValue: Fast Track maximum_F1_bandwidth_value global setting.ProcessWithPraatsetFastTrackMaximumF1FrequencyValue(int newFastTrackMaximumF1FrequencyValue)Setter forfastTrackMaximumF1FrequencyValue: Fast Track maximum_F1_frequency_value global setting.ProcessWithPraatsetFastTrackMaximumF2BandwidthValue(int newFastTrackMaximumF2BandwidthValue)Setter forfastTrackMaximumF2BandwidthValue: Fast Track maximum_F2_bandwidth_value global setting.ProcessWithPraatsetFastTrackMaximumF3BandwidthValue(int newFastTrackMaximumF3BandwidthValue)Setter forfastTrackMaximumF3BandwidthValue: Fast Track maximum_F3_bandwidth_value global setting.ProcessWithPraatsetFastTrackMinimumDuration(double newFastTrackMinimumDuration)Setter forfastTrackMinimumDuration: Minimum duration of a segment for FastTrack analysis.ProcessWithPraatsetFastTrackMinimumF4FrequencyValue(int newFastTrackMinimumF4FrequencyValue)Setter forfastTrackMinimumF4FrequencyValue: Fast Track minimum_F4_frequency_value global setting.ProcessWithPraatsetFastTrackNumberOfCoefficients(int newFastTrackNumberOfCoefficients)Setter forfastTrackNumberOfCoefficients: Fast Track number of coefficients for the regression function.ProcessWithPraatsetFastTrackNumberOfFormants(int newFastTrackNumberOfFormants)Setter forfastTrackNumberOfFormants: Fast Track number of formants.ProcessWithPraatsetFastTrackNumberOfSteps(int newFastTrackNumberOfSteps)Setter forfastTrackNumberOfSteps: Fast Track number of steps.ProcessWithPraatsetFastTrackTimeStep(double newFastTrackTimeStep)Setter forfastTrackTimeStep: Fast Track time_step global setting.ProcessWithPraatsetFastTrackTrackingMethod(String newFastTrackTrackingMethod)Setter forfastTrackTrackingMethod: Fast Track tracking_method parameter for trackAutoselectProcedure; "burg" or "robust".ProcessWithPraatsetFieldDelimiter(char cNewFieldDelimiter)Setter forfieldDelimiter: The field delimiter character for the CSV file.ProcessWithPraatsetFileName(String sNewFileName)Setter forfileName: Name to use as the basis for an output file nameProcessWithPraatsetFormantCeilingDefault(int newFormantCeilingDefault)Setter forformantCeilingDefault: Formant ceiling by default.ProcessWithPraatsetFormantCeilingOther(Vector<Integer> newFormantCeilingOther)Setter forformantCeilingOther: Values to use as the formant ceiling for participants who's attribute value matches the corresponding regular expression informantOtherPattern.ProcessWithPraatsetFormantDifferentiationLayerId(String newFormantDifferentiationLayerId)Setter forformantDifferentiationLayerId: Participant attribute layer ID for differentiating formant settings.ProcessWithPraatsetIntensityDifferentiationLayerId(String newIntensityDifferentiationLayerId)Setter forintensityDifferentiationLayerId: Participant attribute layer ID for differentiating intensity settings.ProcessWithPraatsetIntensityPitchFloorDefault(int newIntensityPitchFloorDefault)Setter forintensityPitchFloorDefault: Intensity Pitch Floor by default.ProcessWithPraatsetIntensityPitchFloorOther(Vector<Integer> newIntensityPitchFloorOther)Setter forintensityPitchFloorOther: Values to use as the intensity pitch floor for participants who's attribute value matches the corresponding regular expression inintensityOtherPattern.ProcessWithPraatsetMarkColumn(int iNewMarkColumn)Setter formarkColumn: Column that identifies the time, or start time if amarkEndColumnis specified, at which the formant should be evaluated.ProcessWithPraatsetMarkEndColumn(Integer iNewMarkEndColumn)Setter formarkEndColumn: Column that identifies the end time of the span for which formants should be evaluated.ProcessWithPraatsetParticipantNameColumn(int iNewParticipantNameColumn)Setter forparticipantNameColumn: The index of the column that specifies the name of the speaker.ProcessWithPraatsetPassThroughData(boolean newPassThroughData)Setter forpassThroughData: Whether to pass data in the original CSV file to the output.ProcessWithPraatsetPitchCeilingDefault(int newPitchCeilingDefault)Setter forpitchCeilingDefault: Pitch Ceiling by default.ProcessWithPraatsetPitchCeilingOther(Vector<Integer> newPitchCeilingOther)Setter forpitchCeilingOther: Values to use as the pitch ceiling for participants who's attribute value matches the corresponding regular expression inpitchOtherPattern.ProcessWithPraatsetPitchDifferentiationLayerId(String newPitchDifferentiationLayerId)Setter forpitchDifferentiationLayerId: Participant attribute layer ID for differentiating pitch settings.ProcessWithPraatsetPitchFloorDefault(int newPitchFloorDefault)Setter forpitchFloorDefault: Pitch Floor by default.ProcessWithPraatsetPitchFloorOther(Vector<Integer> newPitchFloorOther)Setter forpitchFloorOther: Values to use as the pitch floor for participants who's attribute value matches the corresponding regular expression inpitchOtherPattern.ProcessWithPraatsetSamplePoints(Vector<Double> vNewSamplePoints)Setter forsamplePoints: List of positions in the segment to take values - 0.0 = at the beginning of the intervale, 1.0 = at the end of the interval, 0.5 in the middle, etc.ProcessWithPraatsetScriptFormant(String sNewScriptFormant)Setter forscriptFormant: Command to send to Praat for creating a formant track.ProcessWithPraatsetScriptIntensity(String sNewScriptIntensity)Setter forscriptIntensity: Command to send to Praat for creating an intensity track.ProcessWithPraatsetScriptPitch(String sNewScriptPitch)Setter forscriptPitch: Command to send to Praat for creating a pitch track.ProcessWithPraatsetScriptSpectrum(String newScriptSpectrum)Setter forscriptSpectrum: Command to send to Praat for creating a spectrum object.ProcessWithPraatsetSimultaneousThreadCount(Integer newSimultaneousThreadCount)Setter forsimultaneousThreadCount: Number of Praat scripts to run in parallel.ProcessWithPraatsetTranscriptIdColumn(int iNewTranscriptIdColumn)Setter fortranscriptIdColumn: Colum that contains the transcript_idProcessWithPraatsetUseFastTrack(boolean newUseFastTrack)Setter foruseFastTrack: Use the FastTrack plugin to generate optimum, smoothed formant tracks.ProcessWithPraatsetVoicingThresholdDefault(double newVoicingThresholdDefault)Setter forvoicingThresholdDefault: Voicing Threshold by default.ProcessWithPraatsetVoicingThresholdOther(Vector<Double> newVoicingThresholdOther)Setter forvoicingThresholdOther: Values to use as the voicing threshold for participants who's attribute value matches the corresponding regular expression inpitchOtherPattern.ProcessWithPraatsetWindowOffset(double dNewWindowOffset)Setter forwindowOffset: How long before in seconds before the start and after the end times to take as a sample window.-
Methods inherited from class nzilbb.labbcat.server.task.Task
defaultThreadName, findTask, findTask, getCreationTime, getDuration, getLastException, getLastKeepAlive, getLog, getMaxLogSize, getResources, getResultTarget, getResultText, getResultUrl, getRunning, getStatus, getStore, getStoreCache, getTaskThreadGroup, getWaitToDieMilliseconds, getWho, keepAlive, release, setLastException, setLastKeepAlive, setMaxLogSize, setResources, setResultTarget, setResultText, setResultUrl, setStatus, setStore, setStoreCache, setWaitToDieMilliseconds, setWho, waitToDie, waitToDie
-
Methods inherited from class java.lang.Thread
activeCount, checkAccess, countStackFrames, currentThread, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, onSpinWait, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, suspend, toString, yield
-
-
-
-
Method Detail
-
getDataFile
public File getDataFile()
Getter fordataFile: CSV data file- Returns:
- CSV data file
-
setDataFile
public ProcessWithPraat setDataFile(File fNewDataFile)
Setter fordataFile: CSV data file, which will be deleted after processing.- Parameters:
fNewDataFile- CSV data file, which will be deleted after processing.
-
getFieldDelimiter
public char getFieldDelimiter()
Getter forfieldDelimiter: The field delimiter character for the CSV file.- Returns:
- The field delimiter character for the CSV file.
-
setFieldDelimiter
public ProcessWithPraat setFieldDelimiter(char cNewFieldDelimiter)
Setter forfieldDelimiter: The field delimiter character for the CSV file.- Parameters:
cNewFieldDelimiter- The field delimiter character for the CSV file.
-
getTranscriptIdColumn
public int getTranscriptIdColumn()
Getter fortranscriptIdColumn: Colum that contains the transcript_id- Returns:
- Colum that contains the transcript_id
-
setTranscriptIdColumn
public ProcessWithPraat setTranscriptIdColumn(int iNewTranscriptIdColumn)
Setter fortranscriptIdColumn: Colum that contains the transcript_id- Parameters:
iNewTranscriptIdColumn- Colum that contains the transcript_id
-
getMarkColumn
public int getMarkColumn()
Getter formarkColumn: Column that identifies the time, or start time if an end column is specified, at which the formant should be evaluated.- Returns:
- Column that identifies the time, or start time if an end column is specified, at which the formant should be evaluated.
-
setMarkColumn
public ProcessWithPraat setMarkColumn(int iNewMarkColumn)
Setter formarkColumn: Column that identifies the time, or start time if amarkEndColumnis specified, at which the formant should be evaluated.- Parameters:
iNewMarkColumn- Column that identifies the time, or start time if an end column is specified, at which the formant should be evaluated.
-
getMarkEndColumn
public Integer getMarkEndColumn()
Getter formarkEndColumn: Column that identifies the end time of the span for which formants should be evaluated. null if MarkColumn is the target time, or non-null ifmarkColumnand MarkEndColumn should be used to define a mid-point at which the formants should be extracted.- Returns:
- Column that identifies the end time of the span for which formants should be
evaluated. null if
markColumnis the target time, or non-null ifmarkColumnand MarkEndColum n should be used to define a mid-point at which the formants should be extracted.
-
setMarkEndColumn
public ProcessWithPraat setMarkEndColumn(Integer iNewMarkEndColumn)
Setter formarkEndColumn: Column that identifies the end time of the span for which formants should be evaluated. null ifmarkColumnis the target time, or non-null ifmarkColumnand MarkEndColumn should be used to define a mid-point at which the formants should be extracted.- Parameters:
iNewMarkEndColumn- Column that identifies the end time of the span for which formants should be evaluated. null ifmarkColumnis the target time, or non-null ifmarkColumnand MarkEndColumn should be used to define a mid-point at which the formants should be extracted.
-
getFileName
public String getFileName()
Getter forfileName: Name to use as the basis for an output file name- Returns:
- Name to use as the basis for an output file name
-
setFileName
public ProcessWithPraat setFileName(String sNewFileName)
Setter forfileName: Name to use as the basis for an output file name- Parameters:
sNewFileName- Name to use as the basis for an output file name
-
getParticipantNameColumn
public int getParticipantNameColumn()
Getter forparticipantNameColumn: The index of the column that specifies the name of the speaker.- Returns:
- The index of the column that specifies the name of the speaker.
-
setParticipantNameColumn
public ProcessWithPraat setParticipantNameColumn(int iNewParticipantNameColumn)
Setter forparticipantNameColumn: The index of the column that specifies the name of the speaker.- Parameters:
iNewParticipantNameColumn- The index of the column that specifies the name of the speaker.
-
getExtractF1
public boolean getExtractF1()
Getter forextractF1: Whether to extract F1- Returns:
- Whether to extract F1
-
setExtractF1
public ProcessWithPraat setExtractF1(boolean bNewExtractF1)
Setter forextractF1: Whether to extract F1- Parameters:
bNewExtractF1- Whether to extract F1
-
getExtractF2
public boolean getExtractF2()
Getter forextractF2: Whether to extract F2- Returns:
- Whether to extract F2
-
setExtractF2
public ProcessWithPraat setExtractF2(boolean bNewExtractF2)
Setter forextractF2: Whether to extract F2- Parameters:
bNewExtractF2- Whether to extract F2
-
getExtractF3
public boolean getExtractF3()
Getter forextractF3: Whether to extract F3- Returns:
- Whether to extract F3
-
setExtractF3
public ProcessWithPraat setExtractF3(boolean bNewExtractF3)
Setter forextractF3: Whether to extract F3- Parameters:
bNewExtractF3- Whether to extract F3
-
getExtractMinimumPitch
public boolean getExtractMinimumPitch()
Getter forextractMinimumPitch: Whether to extract the minimum pitch- Returns:
- Whether to extract the minimum pitch
-
setExtractMinimumPitch
public ProcessWithPraat setExtractMinimumPitch(boolean bNewExtractMinimumPitch)
Setter forextractMinimumPitch: Whether to extract the minimum pitch- Parameters:
bNewExtractMinimumPitch- Whether to extract the minimum pitch
-
getExtractMaximumPitch
public boolean getExtractMaximumPitch()
Getter forextractMaximumPitch: Whether to extract the maximum pitch- Returns:
- Whether to extract the maximum pitch
-
setExtractMaximumPitch
public ProcessWithPraat setExtractMaximumPitch(boolean bNewExtractMaximumPitch)
Setter forextractMaximumPitch: Whether to extract the maximum pitch- Parameters:
bNewExtractMaximumPitch- Whether to extract the maximum pitch
-
getExtractMeanPitch
public boolean getExtractMeanPitch()
Getter forextractMeanPitch: Whether to extract the mean pitch- Returns:
- Whether to extract the mean pitch
-
setExtractMeanPitch
public ProcessWithPraat setExtractMeanPitch(boolean bNewExtractMeanPitch)
Setter forextractMeanPitch: Whether to extract the mean pitch- Parameters:
bNewExtractMeanPitch- Whether to extract the mean pitch
-
getExtractMaximumIntensity
public boolean getExtractMaximumIntensity()
Getter forextractMaximumIntensity: Whether to extract the maximum intensity- Returns:
- Whether to extract the maximum intensity
-
setExtractMaximumIntensity
public ProcessWithPraat setExtractMaximumIntensity(boolean bNewExtractMaximumIntensity)
Setter forextractMaximumIntensity: Whether to extract the maximum intensity- Parameters:
bNewExtractMaximumIntensity- Whether to extract the maximum intensity
-
getExtractCOG1
public boolean getExtractCOG1()
Getter forextractCOG1: Whether to extract the centre of gravity, with p = 1.- Returns:
- Whether to extract the centre of gravity, with p = 1.
-
setExtractCOG1
public ProcessWithPraat setExtractCOG1(boolean newExtractCOG1)
Setter forextractCOG1: Whether to extract the centre of gravity, with p = 1.- Parameters:
newExtractCOG1- Whether to extract the centre of gravity, with p = 1.
-
getExtractCOG2
public boolean getExtractCOG2()
Getter forextractCOG2: Whether to extract the centre of gravity, with p = 2.- Returns:
- Whether to extract the centre of gravity, with p = 2.
-
setExtractCOG2
public ProcessWithPraat setExtractCOG2(boolean newExtractCOG2)
Setter forextractCOG2: Whether to extract the centre of gravity, with p = 2.- Parameters:
newExtractCOG2- Whether to extract the centre of gravity, with p = 2.
-
getExtractCOG23
public boolean getExtractCOG23()
Getter forextractCOG23: Whether to extract the centre of gravity, with p = 2/3.- Returns:
- Whether to extract the centre of gravity, with p = 2/3.
-
setExtractCOG23
public ProcessWithPraat setExtractCOG23(boolean newExtractCOG23)
Setter forextractCOG23: Whether to extract the centre of gravity, with p = 2/3.- Parameters:
newExtractCOG23- Whether to extract the centre of gravity, with p = 2/3.
-
getWindowOffset
public double getWindowOffset()
Getter forwindowOffset: How long before in seconds before the start and after the end times to take as a sample window. Default is 0.025s (25ms).- Returns:
- How long before in seconds before the start and after the end times to take as a sample window.
-
setWindowOffset
public ProcessWithPraat setWindowOffset(double dNewWindowOffset)
Setter forwindowOffset: How long before in seconds before the start and after the end times to take as a sample window.- Parameters:
dNewWindowOffset- How long before in seconds before the start and after the end times to take as a sample window.
-
getScriptFormant
public String getScriptFormant()
Getter forscriptFormant: Command to send to Praat for creating a formant track.- Returns:
- Command to send to Praat for creating a formant track.
-
setScriptFormant
public ProcessWithPraat setScriptFormant(String sNewScriptFormant)
Setter forscriptFormant: Command to send to Praat for creating a formant track.- Parameters:
sNewScriptFormant- Command to send to Praat for creating a formant track.
-
getFormantCeilingDefault
public int getFormantCeilingDefault()
Getter forformantCeilingDefault: Formant ceiling by default. Default value is 5500.- Returns:
- Formant ceiling by default.
-
setFormantCeilingDefault
public ProcessWithPraat setFormantCeilingDefault(int newFormantCeilingDefault)
Setter forformantCeilingDefault: Formant ceiling by default.- Parameters:
newFormantCeilingDefault- Formant ceiling by default.
-
getFormantDifferentiationLayerId
public String getFormantDifferentiationLayerId()
Getter forformantDifferentiationLayerId: Participant attribute layer ID for differentiating formant settings. This will typically be "participant_gender" but can be any participant attribute layer.- Returns:
- Participant attribute layer ID for differentiating formant settings. This will typically be "participant_gender" but can be any participant attribute layer.
-
setFormantDifferentiationLayerId
public ProcessWithPraat setFormantDifferentiationLayerId(String newFormantDifferentiationLayerId)
Setter forformantDifferentiationLayerId: Participant attribute layer ID for differentiating formant settings. This will typically be "participant_gender" but can be any participant attribute layer.- Parameters:
newFormantDifferentiationLayerId- Participant attribute layer ID for differentiating formant settings. This will typically be "participant_gender" but can be any participant attribute layer.
-
getFormantOtherPattern
public Vector<Pattern> getFormantOtherPattern()
Getter forformantOtherPattern: List of regular expression strings to match against the value of that attribute identified byformantDifferentiationLayerId. If the participant's attribute value matches the pattern for an element in this array, the corresponding element informantCeilingOtherwill be used for that participant.By default, it includes one entry: "M" to match male participants.
- Returns:
- List of regular expression strings to match against the value of that
attribute identified by
formantDifferentiationLayerId. If the participant's attribute value matches the pattern for an element in this array, the corresponding element informantCeilingOtherwill be used for that participant.
-
getFormantCeilingOther
public Vector<Integer> getFormantCeilingOther()
Getter forformantCeilingOther: Values to use as the formant ceiling for participants who's attribute value matches the corresponding regular expression informantOtherPattern.By default, it includes one entry: 5000 for male participants.
- Returns:
- Values to use as the formant ceiling for participants who's attribute value
matches the corresponding regular expression in
formantOtherPattern.
-
setFormantCeilingOther
public ProcessWithPraat setFormantCeilingOther(Vector<Integer> newFormantCeilingOther)
Setter forformantCeilingOther: Values to use as the formant ceiling for participants who's attribute value matches the corresponding regular expression informantOtherPattern.- Parameters:
newFormantCeilingOther- Values to use as the formant ceiling for participants who's attribute value matches the corresponding regular expression informantOtherPattern.
-
getSamplePoints
public Vector<Double> getSamplePoints()
Getter forsamplePoints: List of positions in the segment to take values - 0.0 = at the beginning of the intervale, 1.0 = at the end of the interval, 0.5 in the middle, etc.By default, it includes one entry: 0.5 to measure at the mid-point.
- Returns:
- List of positions in the segment to take values - 0.0 = at the beginning of the intervale, 1.0 = at the end of the interval, 0.5 in the middle, etc.
-
setSamplePoints
public ProcessWithPraat setSamplePoints(Vector<Double> vNewSamplePoints)
Setter forsamplePoints: List of positions in the segment to take values - 0.0 = at the beginning of the intervale, 1.0 = at the end of the interval, 0.5 in the middle, etc.- Parameters:
vNewSamplePoints- List of positions in the segment to take values - 0.0 = at the beginning of the intervale, 1.0 = at the end of the interval, 0.5 in the middle, etc.
-
getScriptPitch
public String getScriptPitch()
Getter forscriptPitch: Command to send to Praat for creating a pitch track.- Returns:
- Command to send to Praat for creating a pitch track.
-
setScriptPitch
public ProcessWithPraat setScriptPitch(String sNewScriptPitch)
Setter forscriptPitch: Command to send to Praat for creating a pitch track.- Parameters:
sNewScriptPitch- Command to send to Praat for creating a pitch track.
-
getPitchDifferentiationLayerId
public String getPitchDifferentiationLayerId()
Getter forpitchDifferentiationLayerId: Participant attribute layer ID for differentiating pitch settings. This will typically be "participant_gender" but can be any participant attribute layer.- Returns:
- Participant attribute layer ID for differentiating pitch settings. This will typically be "participant_gender" but can be any participant attribute layer.
-
setPitchDifferentiationLayerId
public ProcessWithPraat setPitchDifferentiationLayerId(String newPitchDifferentiationLayerId)
Setter forpitchDifferentiationLayerId: Participant attribute layer ID for differentiating pitch settings. This will typically be "participant_gender" but can be any participant attribute layer.- Parameters:
newPitchDifferentiationLayerId- Participant attribute layer ID for differentiating pitch settings. This will typically be "participant_gender" but can be any participant attribute layer.
-
getPitchOtherPattern
public Vector<Pattern> getPitchOtherPattern()
Getter forpitchOtherPattern: List of regular expression strings to match against the value of that attribute identified bypitchDifferentiationLayerId. If the participant's attribute value matches the pattern for an element in this array, the corresponding element inpitchCeilingOtherwill be used for that participant.By default, it includes one entry: "M" to match male participants.
- Returns:
- List of regular expression strings to match against the value of that
attribute identified by
pitchDifferentiationLayerId. If the participant's attribute value matches the pattern for an element in this array, the corresponding element inpitchCeilingOtherwill be used for that participant.
-
getPitchFloorDefault
public int getPitchFloorDefault()
Getter forpitchFloorDefault: Pitch Floor by default. Default value is 60.- Returns:
- Pitch Floor by default.
-
setPitchFloorDefault
public ProcessWithPraat setPitchFloorDefault(int newPitchFloorDefault)
Setter forpitchFloorDefault: Pitch Floor by default.- Parameters:
newPitchFloorDefault- Pitch Floor by default.
-
getPitchFloorOther
public Vector<Integer> getPitchFloorOther()
Getter forpitchFloorOther: Values to use as the pitch floor for participants who's attribute value matches the corresponding regular expression inpitchOtherPattern.By default, it includes one entry: 30 for male participants.
- Returns:
- Values to use as the pitch floor for participants who's attribute value
matches the corresponding regular expression in
pitchOtherPattern.
-
setPitchFloorOther
public ProcessWithPraat setPitchFloorOther(Vector<Integer> newPitchFloorOther)
Setter forpitchFloorOther: Values to use as the pitch floor for participants who's attribute value matches the corresponding regular expression inpitchOtherPattern.- Parameters:
newPitchFloorOther- Values to use as the pitch floor for participants who's attribute value matches the corresponding regular expression inpitchOtherPattern.
-
getPitchCeilingDefault
public int getPitchCeilingDefault()
Getter forpitchCeilingDefault: Pitch Ceiling by default. Default value is 500.- Returns:
- Pitch Ceiling by default.
-
setPitchCeilingDefault
public ProcessWithPraat setPitchCeilingDefault(int newPitchCeilingDefault)
Setter forpitchCeilingDefault: Pitch Ceiling by default.- Parameters:
newPitchCeilingDefault- Pitch Ceiling by default.
-
getPitchCeilingOther
public Vector<Integer> getPitchCeilingOther()
Getter forpitchCeilingOther: Values to use as the pitch ceiling for participants who's attribute value matches the corresponding regular expression inpitchOtherPattern.By default, it includes one entry: 250 for male participants.
- Returns:
- Values to use as the pitch ceiling for participants who's attribute value
matches the corresponding regular expression in
pitchOtherPattern.
-
setPitchCeilingOther
public ProcessWithPraat setPitchCeilingOther(Vector<Integer> newPitchCeilingOther)
Setter forpitchCeilingOther: Values to use as the pitch ceiling for participants who's attribute value matches the corresponding regular expression inpitchOtherPattern.- Parameters:
newPitchCeilingOther- Values to use as the pitch ceiling for participants who's attribute value matches the corresponding regular expression inpitchOtherPattern.
-
getVoicingThresholdDefault
public double getVoicingThresholdDefault()
Getter forvoicingThresholdDefault: Voicing Threshold by default. Default value 0.5.- Returns:
- Voicing Threshold by default.
-
setVoicingThresholdDefault
public ProcessWithPraat setVoicingThresholdDefault(double newVoicingThresholdDefault)
Setter forvoicingThresholdDefault: Voicing Threshold by default.- Parameters:
newVoicingThresholdDefault- Voicing Threshold by default.
-
getVoicingThresholdOther
public Vector<Double> getVoicingThresholdOther()
Getter forvoicingThresholdOther: Values to use as the voicing threshold for participants who's attribute value matches the corresponding regular expression inpitchOtherPattern.By default, it includes one entry: 0.4 for male participants.
- Returns:
- Values to use as the voicing threshold for participants who's attribute value
matches the corresponding regular expression in
pitchOtherPattern.
-
setVoicingThresholdOther
public ProcessWithPraat setVoicingThresholdOther(Vector<Double> newVoicingThresholdOther)
Setter forvoicingThresholdOther: Values to use as the voicing threshold for participants who's attribute value matches the corresponding regular expression inpitchOtherPattern.- Parameters:
newVoicingThresholdOther- Values to use as the voicing threshold for participants who's attribute value matches the corresponding regular expression inpitchOtherPattern.
-
getScriptIntensity
public String getScriptIntensity()
Getter forscriptIntensity: Command to send to Praat for creating an intensity track.- Returns:
- Command to send to Praat for creating an intensity track.
-
setScriptIntensity
public ProcessWithPraat setScriptIntensity(String sNewScriptIntensity)
Setter forscriptIntensity: Command to send to Praat for creating an intensity track.- Parameters:
sNewScriptIntensity- Command to send to Praat for creating an intensity track.
-
getIntensityDifferentiationLayerId
public String getIntensityDifferentiationLayerId()
Getter forintensityDifferentiationLayerId: Participant attribute layer ID for differentiating intensity settings. This will typically be "participant_gender" but can be any participant attribute layer.- Returns:
- Participant attribute layer ID for differentiating intensity settings. This will typically be "participant_gender" but can be any participant attribute layer.
-
setIntensityDifferentiationLayerId
public ProcessWithPraat setIntensityDifferentiationLayerId(String newIntensityDifferentiationLayerId)
Setter forintensityDifferentiationLayerId: Participant attribute layer ID for differentiating intensity settings. This will typically be "participant_gender" but can be any participant attribute layer.- Parameters:
newIntensityDifferentiationLayerId- Participant attribute layer ID for differentiating intensity settings. This will typically be "participant_gender" but can be any participant attribute layer.
-
getIntensityOtherPattern
public Vector<Pattern> getIntensityOtherPattern()
Getter forintensityOtherPattern: List of regular expression strings to match against the value of that attribute identified byintensityDifferentiationLayerId. If the participant's attribute value matches the pattern for an element in this array, the corresponding element inintensityPitchFloorOtheretc. will be used for that participant.By default, it includes one entry: "M" to match male participants.
- Returns:
- List of regular expression strings to match against the value of that
attribute identified by
intensityDifferentiationLayerId. If the participant's attribute value matches the pattern for an element in this array, the corresponding element inintensityPitchFloorOtheretc. will be used for that participant.
-
getIntensityPitchFloorDefault
public int getIntensityPitchFloorDefault()
Getter forintensityPitchFloorDefault: Intensity Pitch Floor by default. Default value is 60.- Returns:
- Intensity Pitch Floor by default.
-
setIntensityPitchFloorDefault
public ProcessWithPraat setIntensityPitchFloorDefault(int newIntensityPitchFloorDefault)
Setter forintensityPitchFloorDefault: Intensity Pitch Floor by default.- Parameters:
newIntensityPitchFloorDefault- Intensity Pitch Floor by default.
-
getIntensityPitchFloorOther
public Vector<Integer> getIntensityPitchFloorOther()
Getter forintensityPitchFloorOther: Values to use as the intensity pitch floor for participants who's attribute value matches the corresponding regular expression inintensityOtherPattern.By default, it includes one entry: 30 for male participants.
- Returns:
- Values to use as the intensity pitch floor for participants who's attribute value
matches the corresponding regular expression in
intensityOtherPattern.
-
setIntensityPitchFloorOther
public ProcessWithPraat setIntensityPitchFloorOther(Vector<Integer> newIntensityPitchFloorOther)
Setter forintensityPitchFloorOther: Values to use as the intensity pitch floor for participants who's attribute value matches the corresponding regular expression inintensityOtherPattern.- Parameters:
newIntensityPitchFloorOther- Values to use as the intensity pitch floor for participants who's attribute value matches the corresponding regular expression inintensityOtherPattern.
-
getScriptSpectrum
public String getScriptSpectrum()
Getter forscriptSpectrum: Command to send to Praat for creating a spectrum object.- Returns:
- Command to send to Praat for creating a spectrum object.
-
setScriptSpectrum
public ProcessWithPraat setScriptSpectrum(String newScriptSpectrum)
Setter forscriptSpectrum: Command to send to Praat for creating a spectrum object.- Parameters:
newScriptSpectrum- Command to send to Praat for creating a spectrum object.
-
getCustomScript
public String getCustomScript()
Getter forcustomScript: Custom script specified by the user to execute on each sample.- Returns:
- Custom script specified by the user to execute on each sample.
-
setCustomScript
public ProcessWithPraat setCustomScript(String newCustomScript)
Setter forcustomScript: Custom script specified by the user to execute on each sample.- Parameters:
newCustomScript- Custom script specified by the user to execute on each sample.
-
getCustomScriptHeaders
public Vector<String> getCustomScriptHeaders()
Getter forcustomScriptHeaders: Headers for custom script outputs.- Returns:
- Headers for custom script outputs.
-
setCustomScriptHeaders
public ProcessWithPraat setCustomScriptHeaders(Vector<String> newCustomScriptHeaders)
Setter forcustomScriptHeaders: Headers for custom script outputs.- Parameters:
newCustomScriptHeaders- Headers for custom script outputs.
-
getAttributes
public HashSet<String> getAttributes()
Getter forattributes: Attributes to make available to custom script.- Returns:
- Attributes to make available to custom script, or null if no attributes are to be made available.
-
getPassThroughData
public boolean getPassThroughData()
Getter forpassThroughData: Whether to pass data in the original CSV file to the output. Default is true.- Returns:
- Whether to pass data in the original CSV file to the output.
-
setPassThroughData
public ProcessWithPraat setPassThroughData(boolean newPassThroughData)
Setter forpassThroughData: Whether to pass data in the original CSV file to the output.- Parameters:
newPassThroughData- Whether to pass data in the original CSV file to the output.
-
getUseFastTrack
public boolean getUseFastTrack()
Getter foruseFastTrack: Use the FastTrack plugin to generate optimum, smoothed formant tracks.- Returns:
- Use the FastTrack plugin to generate optimum, smoothed formant tracks.
-
setUseFastTrack
public ProcessWithPraat setUseFastTrack(boolean newUseFastTrack)
Setter foruseFastTrack: Use the FastTrack plugin to generate optimum, smoothed formant tracks.- Parameters:
newUseFastTrack- Use the FastTrack plugin to generate optimum, smoothed formant tracks.
-
getFastTrackTimeStep
public double getFastTrackTimeStep()
Getter forfastTrackTimeStep: Fast Track time_step global setting - time step in seconds.- Returns:
- Fast Track time_step global setting.
-
setFastTrackTimeStep
public ProcessWithPraat setFastTrackTimeStep(double newFastTrackTimeStep)
Setter forfastTrackTimeStep: Fast Track time_step global setting.- Parameters:
newFastTrackTimeStep- Fast Track time_step global setting.
-
getFastTrackBasisFunctions
public String getFastTrackBasisFunctions()
Getter forfastTrackBasisFunctions: Fast Track basis_functions global setting.- Returns:
- Fast Track basis_functions global setting.
-
setFastTrackBasisFunctions
public ProcessWithPraat setFastTrackBasisFunctions(String newFastTrackBasisFunctions)
Setter forfastTrackBasisFunctions: Fast Track basis_functions global setting.- Parameters:
newFastTrackBasisFunctions- Fast Track basis_functions global setting.
-
getFastTrackErrorMethod
public String getFastTrackErrorMethod()
Getter forfastTrackErrorMethod: Fast Track error_method global setting.- Returns:
- Fast Track error_method global setting.
-
setFastTrackErrorMethod
public ProcessWithPraat setFastTrackErrorMethod(String newFastTrackErrorMethod)
Setter forfastTrackErrorMethod: Fast Track error_method global setting.- Parameters:
newFastTrackErrorMethod- Fast Track error_method global setting.
-
getFastTrackTrackingMethod
public String getFastTrackTrackingMethod()
Getter forfastTrackTrackingMethod: Fast Track tracking_method parameter for trackAutoselectProcedure; "burg" or "robust".- Returns:
- Fast Track tracking_method parameter for trackAutoselectProcedure; "burg" or "robust".
-
setFastTrackTrackingMethod
public ProcessWithPraat setFastTrackTrackingMethod(String newFastTrackTrackingMethod)
Setter forfastTrackTrackingMethod: Fast Track tracking_method parameter for trackAutoselectProcedure; "burg" or "robust".- Parameters:
newFastTrackTrackingMethod- Fast Track tracking_method parameter for trackAutoselectProcedure; "burg" or "robust".
-
getFastTrackEnableF1FrequencyHeuristic
public boolean getFastTrackEnableF1FrequencyHeuristic()
Getter forfastTrackEnableF1FrequencyHeuristic: Fast Track enable_F1_frequency_heuristic global setting.- Returns:
- Fast Track enable_F1_frequency_heuristic global setting.
- See Also:
getFastTrackMaximumF1FrequencyValue()
-
setFastTrackEnableF1FrequencyHeuristic
public ProcessWithPraat setFastTrackEnableF1FrequencyHeuristic(boolean newFastTrackEnableF1FrequencyHeuristic)
Setter forfastTrackEnableF1FrequencyHeuristic: Fast Track enable_F1_frequency_heuristic global setting.- Parameters:
newFastTrackEnableF1FrequencyHeuristic- Fast Track enable_F1_frequency_heuristic global setting.- See Also:
getFastTrackMaximumF1FrequencyValue()
-
getFastTrackMaximumF1FrequencyValue
public int getFastTrackMaximumF1FrequencyValue()
Getter forfastTrackMaximumF1FrequencyValue: Fast Track maximum_F1_frequency_value global setting. Median F1 frequency should not be higher than this value.- Returns:
- Fast Track maximum_F1_frequency_value global setting.
-
setFastTrackMaximumF1FrequencyValue
public ProcessWithPraat setFastTrackMaximumF1FrequencyValue(int newFastTrackMaximumF1FrequencyValue)
Setter forfastTrackMaximumF1FrequencyValue: Fast Track maximum_F1_frequency_value global setting. Median F1 frequency should not be higher than this value.- Parameters:
newFastTrackMaximumF1FrequencyValue- Fast Track maximum_F1_frequency_value global setting.
-
getFastTrackEnableF1BandwidthHeuristic
public boolean getFastTrackEnableF1BandwidthHeuristic()
Getter forfastTrackEnableF1BandwidthHeuristic: Fast Track enable_F1_bandwidth_heuristic global setting.- Returns:
- Fast Track enable_F1_bandwidth_heuristic global setting.
- See Also:
getFastTrackMaximumF1BandwidthValue()
-
setFastTrackEnableF1BandwidthHeuristic
public ProcessWithPraat setFastTrackEnableF1BandwidthHeuristic(boolean newFastTrackEnableF1BandwidthHeuristic)
Setter forfastTrackEnableF1BandwidthHeuristic: Fast Track enable_F1_bandwidth_heuristic global setting.- Parameters:
newFastTrackEnableF1BandwidthHeuristic- Fast Track enable_F1_bandwidth_heuristic global setting.- See Also:
getFastTrackMaximumF1BandwidthValue()
-
getFastTrackMaximumF1BandwidthValue
public int getFastTrackMaximumF1BandwidthValue()
Getter forfastTrackMaximumF1BandwidthValue: Fast Track maximum_F1_bandwidth_value global setting. Median F1 bandwidth should not be higher than this value.- Returns:
- Fast Track maximum_F1_bandwidth_value global setting.
-
setFastTrackMaximumF1BandwidthValue
public ProcessWithPraat setFastTrackMaximumF1BandwidthValue(int newFastTrackMaximumF1BandwidthValue)
Setter forfastTrackMaximumF1BandwidthValue: Fast Track maximum_F1_bandwidth_value global setting. Median F1 bandwidth should not be higher than this value.- Parameters:
newFastTrackMaximumF1BandwidthValue- Fast Track maximum_F1_bandwidth_value global setting.
-
getFastTrackEnableF2BandwidthHeuristic
public boolean getFastTrackEnableF2BandwidthHeuristic()
Getter forfastTrackEnableF2BandwidthHeuristic: Fast Track enable_F2_bandwidth_heuristic global setting.- Returns:
- Fast Track enable_F2_bandwidth_heuristic global setting.
- See Also:
getFastTrackMaximumF2BandwidthValue()
-
setFastTrackEnableF2BandwidthHeuristic
public ProcessWithPraat setFastTrackEnableF2BandwidthHeuristic(boolean newFastTrackEnableF2BandwidthHeuristic)
Setter forfastTrackEnableF2BandwidthHeuristic: Fast Track enable_F2_bandwidth_heuristic global setting.- Parameters:
newFastTrackEnableF2BandwidthHeuristic- Fast Track enable_F2_bandwidth_heuristic global setting.- See Also:
getFastTrackMaximumF2BandwidthValue()
-
getFastTrackMaximumF2BandwidthValue
public int getFastTrackMaximumF2BandwidthValue()
Getter forfastTrackMaximumF2BandwidthValue: Fast Track maximum_F2_bandwidth_value global setting. Median F2 bandwidth should not be higher than this value. Default is 600.- Returns:
- Fast Track maximum_F2_bandwidth_value global setting.
-
setFastTrackMaximumF2BandwidthValue
public ProcessWithPraat setFastTrackMaximumF2BandwidthValue(int newFastTrackMaximumF2BandwidthValue)
Setter forfastTrackMaximumF2BandwidthValue: Fast Track maximum_F2_bandwidth_value global setting. Median F2 bandwidth should not be higher than this value. Default is 600.- Parameters:
newFastTrackMaximumF2BandwidthValue- Fast Track maximum_F2_bandwidth_value global setting.
-
getFastTrackEnableF3BandwidthHeuristic
public boolean getFastTrackEnableF3BandwidthHeuristic()
Getter forfastTrackEnableF3BandwidthHeuristic: Fast Track enable_F3_bandwidth_heuristic global setting.- Returns:
- Fast Track enable_F3_bandwidth_heuristic global setting.
- See Also:
getFastTrackMaximumF3BandwidthValue()
-
setFastTrackEnableF3BandwidthHeuristic
public ProcessWithPraat setFastTrackEnableF3BandwidthHeuristic(boolean newFastTrackEnableF3BandwidthHeuristic)
Setter forfastTrackEnableF3BandwidthHeuristic: Fast Track enable_F3_bandwidth_heuristic global setting.- Parameters:
newFastTrackEnableF3BandwidthHeuristic- Fast Track enable_F3_bandwidth_heuristic global setting.- See Also:
getFastTrackMaximumF3BandwidthValue()
-
getFastTrackMaximumF3BandwidthValue
public int getFastTrackMaximumF3BandwidthValue()
Getter forfastTrackMaximumF3BandwidthValue: Fast Track maximum_F3_bandwidth_value global setting. Median F3 bandwidth should not be higher than this value. Default is 900.- Returns:
- Fast Track maximum_F3_bandwidth_value global setting.
-
setFastTrackMaximumF3BandwidthValue
public ProcessWithPraat setFastTrackMaximumF3BandwidthValue(int newFastTrackMaximumF3BandwidthValue)
Setter forfastTrackMaximumF3BandwidthValue: Fast Track maximum_F3_bandwidth_value global setting. Median F3 bandwidth should not be higher than this value. Default is 900.- Parameters:
newFastTrackMaximumF3BandwidthValue- Fast Track maximum_F3_bandwidth_value global setting.
-
getFastTrackEnableF4FrequencyHeuristic
public boolean getFastTrackEnableF4FrequencyHeuristic()
Getter forfastTrackEnableF4FrequencyHeuristic: Fast Track enable_F4_frequency_heuristic global setting.- Returns:
- Fast Track enable_F4_frequency_heuristic global setting.
- See Also:
getFastTrackMinimumF4FrequencyValue()
-
setFastTrackEnableF4FrequencyHeuristic
public ProcessWithPraat setFastTrackEnableF4FrequencyHeuristic(boolean newFastTrackEnableF4FrequencyHeuristic)
Setter forfastTrackEnableF4FrequencyHeuristic: Fast Track enable_F4_frequency_heuristic global setting.- Parameters:
newFastTrackEnableF4FrequencyHeuristic- Fast Track enable_F4_frequency_heuristic global setting.- See Also:
getFastTrackMinimumF4FrequencyValue()
-
getFastTrackMinimumF4FrequencyValue
public int getFastTrackMinimumF4FrequencyValue()
Getter forfastTrackMinimumF4FrequencyValue: Fast Track minimum_F4_frequency_value global setting. Median F4 frequency should not be lower than this value. Default is 2900.- Returns:
- Fast Track minimum_F4_frequency_value global setting.
-
setFastTrackMinimumF4FrequencyValue
public ProcessWithPraat setFastTrackMinimumF4FrequencyValue(int newFastTrackMinimumF4FrequencyValue)
Setter forfastTrackMinimumF4FrequencyValue: Fast Track minimum_F4_frequency_value global setting. Median F4 frequency should not be lower than this value. Default is 2900.- Parameters:
newFastTrackMinimumF4FrequencyValue- Fast Track minimum_F4_frequency_value global setting.
-
getFastTrackEnableRhoticHeuristic
public boolean getFastTrackEnableRhoticHeuristic()
Getter forfastTrackEnableRhoticHeuristic: Fast Track enable_rhotic_heuristic global setting. If F3 < 2000 Hz, F1 and F2 should be at least 500 Hz apart. Enabled by default.- Returns:
- Fast Track enable_rhotic_heuristic global setting.
-
setFastTrackEnableRhoticHeuristic
public ProcessWithPraat setFastTrackEnableRhoticHeuristic(boolean newFastTrackEnableRhoticHeuristic)
Setter forfastTrackEnableRhoticHeuristic: Fast Track enable_rhotic_heuristic global setting. If F3 < 2000 Hz, F1 and F2 should be at least 500 Hz apart. Enabled by default.- Parameters:
newFastTrackEnableRhoticHeuristic- Fast Track enable_rhotic_heuristic global setting.
-
getFastTrackEnableF3F4ProximityHeuristic
public boolean getFastTrackEnableF3F4ProximityHeuristic()
Getter forfastTrackEnableF3F4ProximityHeuristic: Fast Track enable_F3F4_proximity_heuristic global setting. If (F4 - F3) < 500 Hz, F1 and F2 should be at least 1500 Hz apart. Enabled by default.- Returns:
- Fast Track enable_F3F4_proximity_heuristic global setting.
-
setFastTrackEnableF3F4ProximityHeuristic
public ProcessWithPraat setFastTrackEnableF3F4ProximityHeuristic(boolean newFastTrackEnableF3F4ProximityHeuristic)
Setter forfastTrackEnableF3F4ProximityHeuristic: Fast Track enable_F3F4_proximity_heuristic global setting. If (F4 - F3) < 500 Hz, F1 and F2 should be at least 1500 Hz apart. Enabled by default.- Parameters:
newFastTrackEnableF3F4ProximityHeuristic- Fast Track enable_F3F4_proximity_heuristic global setting.
-
getFastTrackNumberOfSteps
public int getFastTrackNumberOfSteps()
Getter forfastTrackNumberOfSteps: Fast Track number of steps. Default value is 20.- Returns:
- Fast Track number of steps.
-
setFastTrackNumberOfSteps
public ProcessWithPraat setFastTrackNumberOfSteps(int newFastTrackNumberOfSteps)
Setter forfastTrackNumberOfSteps: Fast Track number of steps.- Parameters:
newFastTrackNumberOfSteps- Fast Track number of steps.
-
getFastTrackNumberOfCoefficients
public int getFastTrackNumberOfCoefficients()
Getter forfastTrackNumberOfCoefficients: Fast Track number of coefficients for the regression function. Default value is 5.- Returns:
- Fast Track number of coefficients for the regression function.
-
setFastTrackNumberOfCoefficients
public ProcessWithPraat setFastTrackNumberOfCoefficients(int newFastTrackNumberOfCoefficients)
Setter forfastTrackNumberOfCoefficients: Fast Track number of coefficients for the regression function.- Parameters:
newFastTrackNumberOfCoefficients- Fast Track number of coefficients for the regression function.
-
getFastTrackNumberOfFormants
public int getFastTrackNumberOfFormants()
Getter forfastTrackNumberOfFormants: Fast Track number of formants. Default value is 3.- Returns:
- Fast Track number of formants.
-
setFastTrackNumberOfFormants
public ProcessWithPraat setFastTrackNumberOfFormants(int newFastTrackNumberOfFormants)
Setter forfastTrackNumberOfFormants: Fast Track number of formants.- Parameters:
newFastTrackNumberOfFormants- Fast Track number of formants.
-
getFastTrackCoefficients
public boolean getFastTrackCoefficients()
Getter forfastTrackCoefficients: Whether to return the regression coefficients from FastTrack.- Returns:
- Whether to return the regression coefficients from FastTrack.
-
setFastTrackCoefficients
public ProcessWithPraat setFastTrackCoefficients(boolean newFastTrackCoefficients)
Setter forfastTrackCoefficients: Whether to return the regression coefficients from FastTrack.- Parameters:
newFastTrackCoefficients- Whether to return the regression coefficients from FastTrack.
-
getFastTrackDifferentiationLayerId
public String getFastTrackDifferentiationLayerId()
Getter forfastTrackDifferentiationLayerId: Participant attribute layer ID for differentiating fastTrack settings. This will typically be "participant_gender" but can be any participant attribute layer.- Returns:
- Participant attribute layer ID for differentiating fastTrack settings. This will typically be "participant_gender" but can be any participant attribute layer.
-
setFastTrackDifferentiationLayerId
public ProcessWithPraat setFastTrackDifferentiationLayerId(String newFastTrackDifferentiationLayerId)
Setter forfastTrackDifferentiationLayerId: Participant attribute layer ID for differentiating fastTrack settings. This will typically be "participant_gender" but can be any participant attribute layer.- Parameters:
newFastTrackDifferentiationLayerId- Participant attribute layer ID for differentiating fastTrack settings. This will typically be "participant_gender" but can be any participant attribute layer.
-
getFastTrackOtherPattern
public Vector<Pattern> getFastTrackOtherPattern()
Getter forfastTrackOtherPattern: List of regular expression strings to match against the value of that attribute identified byfastTrackDifferentiationLayerId. If the participant's attribute value matches the pattern for an element in this array, the corresponding element infastTrackLowestAnalysisFrequencyOtheretc. will be used for that participant.By default, it includes one entry: "M" to match male participants.
- Returns:
- List of regular expression strings to match against the value of that
attribute identified by
fastTrackDifferentiationLayerId. If the participant's attribute value matches the pattern for an element in this array, the corresponding element infastTrackLowestAnalysisFrequencyOtheretc. will be used for that participant.
-
getFastTrackLowestAnalysisFrequencyDefault
public int getFastTrackLowestAnalysisFrequencyDefault()
Getter forfastTrackLowestAnalysisFrequencyDefault: Fast Track lowest analysis frequency by default.The default value is 5000.
- Returns:
- Fast Track lowest analysis frequency by default.
-
setFastTrackLowestAnalysisFrequencyDefault
public ProcessWithPraat setFastTrackLowestAnalysisFrequencyDefault(int newFastTrackLowestAnalysisFrequencyDefault)
Setter forfastTrackLowestAnalysisFrequencyDefault: Fast Track lowest analysis frequency by default.- Parameters:
newFastTrackLowestAnalysisFrequencyDefault- Fast Track lowest analysis frequency by default.
-
getFastTrackLowestAnalysisFrequencyOther
public Vector<Integer> getFastTrackLowestAnalysisFrequencyOther()
Getter forfastTrackLowestAnalysisFrequencyOther: Values to use as the Fast Track lowest analysis frequency for participants who's attribute value matches the corresponding regular expression infastTrackOtherPattern.By default, it includes one entry: 4500 for male participants.
- Returns:
- Values to use as the Fast Track lowest analysis frequency for participants who's attribute value matches the corresponding regular expression in
fastTrackOtherPattern.
-
setFastTrackLowestAnalysisFrequencyOther
public ProcessWithPraat setFastTrackLowestAnalysisFrequencyOther(Vector<Integer> newFastTrackLowestAnalysisFrequencyOther)
Setter forfastTrackLowestAnalysisFrequencyOther: Values to use as the Fast Track lowest analysis frequency for participants who's attribute value matches the corresponding regular expression infastTrackOtherPattern.- Parameters:
newFastTrackLowestAnalysisFrequencyOther- Values to use as the Fast Track lowest analysis frequency for participants who's attribute value matches the corresponding regular expression infastTrackOtherPattern.
-
getFastTrackHighestAnalysisFrequencyDefault
public int getFastTrackHighestAnalysisFrequencyDefault()
Getter forfastTrackHighestAnalysisFrequencyDefault: Fast Track highest analysis frequency by default.The default value is 7000.
- Returns:
- Fast Track highest analysis frequency by default.
-
setFastTrackHighestAnalysisFrequencyDefault
public ProcessWithPraat setFastTrackHighestAnalysisFrequencyDefault(int newFastTrackHighestAnalysisFrequencyDefault)
Setter forfastTrackHighestAnalysisFrequencyDefault: Fast Track highest analysis frequency by default.- Parameters:
newFastTrackHighestAnalysisFrequencyDefault- Fast Track highest analysis frequency by default.
-
getFastTrackHighestAnalysisFrequencyOther
public Vector<Integer> getFastTrackHighestAnalysisFrequencyOther()
Getter forfastTrackHighestAnalysisFrequencyOther: Values to use as the Fast Track highest analysis frequency for participants who's attribute value matches the corresponding regular expression informantOtherPattern.By default, it includes one entry: 6500 for male participants.
- Returns:
- Values to use as the Fast Track highest analysis frequency for participants who's attribute value matches the corresponding regular expression in
formantOtherPattern.
-
setFastTrackHighestAnalysisFrequencyOther
public ProcessWithPraat setFastTrackHighestAnalysisFrequencyOther(Vector<Integer> newFastTrackHighestAnalysisFrequencyOther)
Setter forfastTrackHighestAnalysisFrequencyOther: Values to use as the Fast Track highest analysis frequency for participants who's attribute value matches the corresponding regular expression informantOtherPattern.- Parameters:
newFastTrackHighestAnalysisFrequencyOther- Values to use as the Fast Track highest analysis frequency for participants who's attribute value matches the corresponding regular expression informantOtherPattern.
-
getFastTrackMinimumDuration
public double getFastTrackMinimumDuration()
Getter forfastTrackMinimumDuration: Minimum duration of a segment for FastTrack analysis. Default is 0.030000000000001s. Segments shorter than this will be ignored, and empty values returned.NB The FastTrack limit is 0.03s (30ms), but because of possible rounding errors in Praat arithemitic, the default is set slightly higher than this.
- Returns:
- Minimum duration of a segment for FastTrack analysis. Segments shorter than this will be ignored, and empty values returned.
-
setFastTrackMinimumDuration
public ProcessWithPraat setFastTrackMinimumDuration(double newFastTrackMinimumDuration)
Setter forfastTrackMinimumDuration: Minimum duration of a segment for FastTrack analysis. Segments shorter than this will be ignored, and empty values returned.- Parameters:
newFastTrackMinimumDuration- Minimum duration of a segment for FastTrack analysis. Segments shorter than this will be ignored, and empty values returned.
-
getSimultaneousThreadCount
public Integer getSimultaneousThreadCount()
Getter forsimultaneousThreadCount: Number of Praat scripts to run in parallel. If unset, the default is the number of processors available.- Returns:
- Number of Praat scripts to run in parallel.
-
setSimultaneousThreadCount
public ProcessWithPraat setSimultaneousThreadCount(Integer newSimultaneousThreadCount)
Setter forsimultaneousThreadCount: Number of Praat scripts to run in parallel.- Parameters:
newSimultaneousThreadCount- Number of Praat scripts to run in parallel.If newSimultaneousThreadCount < 1 then 1 is used instead.
-
addAttributes
public void addAttributes(String[] attributes)
Adds an array of attribute names toattributes.- Parameters:
attributes-
-
getPercentComplete
public Integer getPercentComplete()
Determines how far through the task is.The override will report progress based on current Callable tasks, if any.
- Specified by:
getPercentCompletein interfacenzilbb.util.MonitorableTask- Overrides:
getPercentCompletein classTask- Returns:
- An integer between 0 and 100 (inclusive), or null if progress can not be calculated.
-
cancel
public void cancel()
Cancels the task. The override cancels any batch tasks that have been created.
-
descriptiveName
public String descriptiveName()
Generates a descriptive name for the processing.- Returns:
- A name that hints at the processing being done (e.g. "praat-F1-F2") if possible, or "praat" if not.
-
run
public void run()
Run the task.
-
processBatch
public FutureTask<File> processBatch(String transcript, String speaker, PreparedStatement sqlSpeakerAttribute, Vector<org.apache.commons.csv.CSVRecord> batch, org.apache.commons.csv.CSVFormat format) throws Exception
Create a Callable that will process a list of lines, all from the same transcript file.The method does some immediate processing, to identify the media file and retrieve participant attributes, but the execution of the corresponding Praat script is deferred until the returned Callable is invoked.
This allows multiple scripts to be executed in parallel, so that processing terminates faster.
- Parameters:
transcript- Name of the transcript.speaker- Name of the participant.sqlSpeakerAttribute- Prepared query that returns a 'label' field that identifies a given participant attribute (parameter 1) given a participant name (parameters 2 and 3).batch- Collection of source CSV records that make up this batch.format- Output CSV format.- Returns:
- A task that will produce a header-less CSV file with the results for this batch, which the caller should delete when finished.
- Throws:
Exception
-
filesAccessed
public boolean filesAccessed()
Determines whether the user-customizable parts of the Praat script include operations for reading/writing files.- Returns:
- true if file access functionality is detected, false otherwise.
-
generateScript
public void generateScript(PrintWriter scriptWriter, File tempDirectory, File wav, Vector<Vector<Double>> targets, Integer formantCeiling, Integer pitchFloor, Integer pitchCeiling, Double voicingThreshold, Integer intensityPitchFloor, Integer fastTrackLowestAnalysisFrequency, Integer fastTrackHighestAnalysisFrequency, HashMap<String,String> attributeValues) throws Exception
Extracts the formants at the given times for the given WAV file- Parameters:
scriptWriter- Writer to write the script to.tempDirectory- A directory that can be used for temporary files generated by the script.wav- WAV file to analyse.targets-formantCeiling-pitchFloor-pitchCeiling-voicingThreshold-intensityPitchFloor-fastTrackLowestAnalysisFrequency-fastTrackHighestAnalysisFrequency-attributeValues- Attribute names (keys) and values for this batch.- Throws:
Exception
-
-