commit fixing various files for the javadoc file under marytts-builder

This commit is contained in:
Aitor Martinez Egurcegui 2015-10-03 11:53:35 +02:00
Родитель 97a0dd1194
Коммит 0d3d8a3a40
26 изменённых файлов: 166 добавлений и 25 удалений

Просмотреть файл

@ -30,7 +30,7 @@ public interface CoverageFeatureProvider {
/**
* Get the total number of sentences provided by this provider.
*
* @param return number of sentences
* @return number of sentences
*/
public int getNumSentences();

Просмотреть файл

@ -317,6 +317,7 @@ public class CARTBuilder extends VoiceImportComponent {
* IOException
* @throws MaryConfigurationException
* MaryConfigurationException
* @return cart
*/
public CART importCART(String filename, FeatureDefinition featDef) throws IOException, MaryConfigurationException {
// open CART-File
@ -346,6 +347,7 @@ public class CARTBuilder extends VoiceImportComponent {
* IOException
* @throws MaryConfigurationException
* MaryConfigurationException
* @return true when done
*/
public boolean replaceLeaves(CART cart, FeatureDefinition featureDefinition) throws IOException, MaryConfigurationException {
try {

Просмотреть файл

@ -864,6 +864,8 @@ public class DatabaseLayout {
/**
* Get all props of all components as an Array representation for displaying with the SettingsGUI. Does not include uneditable
* props.
*
* @return result
*/
public String[][] getAllPropsForDisplay() {
List<String> keys = new ArrayList<String>();

Просмотреть файл

@ -185,8 +185,8 @@ public class HMMParameterExtractor extends VoiceImportComponent {
* outputDir
* @throws IOException
* IOException
* @param InterruptedException
* InterruptedException
* @throws InterruptedException
* InterruptedException
*/
public void generateParameters(String file, String contextFeaDir, String outputDir) throws IOException, InterruptedException {

Просмотреть файл

@ -217,6 +217,7 @@ public class PhoneFeatureFileWriter extends VoiceImportComponent {
* @param out
* out
* @throws IOException
* IOException
*/
protected void writeHeaderTo(DataOutput out) throws IOException {
new MaryHeader(MaryHeader.UNITFEATS).writeTo(out);

Просмотреть файл

@ -130,6 +130,10 @@ public class SPTKMFCCExtractor extends VoiceImportComponent {
/***
* Calculate mfcc using SPTK, uses sox to convert wav&rarr;raw
*
* @param inFile
* inFile
* @param outFile
* outFile
* @throws IOException
* IOException
* @throws InterruptedException

Просмотреть файл

@ -166,6 +166,7 @@ public class TimelineWriter {
*
* @throws IOException
* IOException
* @return raf.getFilePointer
*/
public synchronized long getBytePointer() throws IOException {
return (raf.getFilePointer());

Просмотреть файл

@ -218,6 +218,28 @@ public class VoiceCompiler extends VoiceImportComponent {
/**
* @deprecated Use constructor with path to Maven instead.
* @param compileDir
* compileDir
* @param voiceName
* voiceName
* @param voiceVersion
* voiceVersion
* @param locale
* locale
* @param gender
* gender
* @param domain
* domain
* @param samplingRate
* samplingRate
* @param isUnitSelectionVoice
* isUnitSelectionVoice
* @param filesForResources
* filesForResources
* @param filesForFilesystem
* filesForFilesystem
* @param extraVariablesToSubstitute
* extraVariablesToSubstitute
*/
@Deprecated
public MavenVoiceCompiler(File compileDir, String voiceName, String voiceVersion, Locale locale, String gender,

Просмотреть файл

@ -334,6 +334,10 @@ public class AgglomerativeClusterer {
/**
* Estimate the mean of all *distances* in the training set.
*
* @param leaves
* leaves
* @return computeglobalimpurity(leaves, double.Positive_infinity)
*/
/*
* private void estimateGlobalMean(FeatureVector[] data, DistanceMeasure dist) { int sampleSize = 100000;
@ -357,7 +361,9 @@ public class AgglomerativeClusterer {
* Compute global impurity as the weighted sum of leaf impurities. stop when cutoff value is reached or surpassed.
*
* @param leaves
* leaves
* @param cutoff
* cutoff
* @return gi
*/
private double computeGlobalImpurity(List<LeafNode> leaves, double cutoff) {
@ -399,6 +405,7 @@ public class AgglomerativeClusterer {
* where |l| = the number of instances in the leaf.
*
* @param leaf
* leaf
* @return impurity
*/
/*
@ -459,7 +466,9 @@ public class AgglomerativeClusterer {
* |l| = number of instances in the leaf l
*
* @param dgn1
* dgn1
* @param dgn2
* dgn2
* @return deltaGI
*/
private double computeMutualDistanceDeltaGI(DirectedGraphNode dgn1, DirectedGraphNode dgn2) {

Просмотреть файл

@ -38,6 +38,9 @@ public class ContourTreeInspector {
/**
* @param args
* args
* @throws Exception
* Exception
*/
public static void main(String[] args) throws Exception {
boolean showIndividualLeaves = true;

Просмотреть файл

@ -31,7 +31,9 @@ public interface DistanceMeasure {
* Compute the distance between two feature vectors.
*
* @param fv1
* fv1
* @param fv2
* fv2
* @return a non-negative float
*/
public float distance(FeatureVector fv1, FeatureVector fv2);
@ -40,7 +42,9 @@ public interface DistanceMeasure {
* Compute the squared distance between two feature vectors.
*
* @param fv1
* fv1
* @param fv2
* fv2
* @return a non-negative float
*/
public float squaredDistance(FeatureVector fv1, FeatureVector fv2);

Просмотреть файл

@ -40,6 +40,11 @@ public class DurationDistanceMeasure implements DistanceMeasure {
* Compute the distance between the f0 contours corresponding to the given feature vectors. From the feature vectors, only
* their unit index number is used.
*
* @param fv1
* fv1
* @param fv2
* fv2
* @return math.abs(d1 - d2)
* @see marytts.tools.voiceimport.traintrees.DistanceMeasure#distance(marytts.features.FeatureVector,
* marytts.features.FeatureVector)
*/
@ -53,6 +58,11 @@ public class DurationDistanceMeasure implements DistanceMeasure {
* Compute the distance between the f0 contours corresponding to the given feature vectors. From the feature vectors, only
* their unit index number is used.
*
* @param fv1
* fv1
* @param fv2
* fv2
* @return diff * diff
* @see marytts.tools.voiceimport.traintrees.DistanceMeasure#distance(marytts.features.FeatureVector,
* marytts.features.FeatureVector)
*/

Просмотреть файл

@ -44,6 +44,11 @@ public class F0ContourPolynomialDistanceMeasure implements DistanceMeasure {
* Compute the distance between the f0 contours corresponding to the given feature vectors. From the feature vectors, only
* their unit index number is used.
*
* @param fv1
* fv1
* @param fv2
* fv2
* @return dist
* @see marytts.tools.voiceimport.traintrees.DistanceMeasure#distance(marytts.features.FeatureVector,
* marytts.features.FeatureVector)
*/
@ -56,6 +61,11 @@ public class F0ContourPolynomialDistanceMeasure implements DistanceMeasure {
* Compute the distance between the f0 contours corresponding to the given feature vectors. From the feature vectors, only
* their unit index number is used.
*
* @param fv1
* fv1
* @param fv2
* fv2
* @return dist
* @see marytts.tools.voiceimport.traintrees.DistanceMeasure#distance(marytts.features.FeatureVector,
* marytts.features.FeatureVector)
*/
@ -73,6 +83,7 @@ public class F0ContourPolynomialDistanceMeasure implements DistanceMeasure {
* Compute the mean polynomial from the given set of polynomials.
*
* @param fvs
* fvs
* @return mean
*/
public float[] computeMean(FeatureVector[] fvs) {
@ -88,6 +99,7 @@ public class F0ContourPolynomialDistanceMeasure implements DistanceMeasure {
* Compute the variance of the given set of feature vectors.
*
* @param fvs
* fvs
* @return variance
*/
public double computeVariance(FeatureVector[] fvs) {

Просмотреть файл

@ -74,12 +74,20 @@ public class Wagon implements Runnable {
/**
* Set up a new wagon process. Wagon.setWagonExecutable() must be called beforehand.
*
* @param id
* id
* @param featureDefinition
* featureDefinition
* @param featureVectors
* featureVectors
* @param aDistanceMeasure
* aDistanceMeasure
* @param dir
* dir
* @param balance
* balance
* @param stop
* stop
* @throws IOException
* if there was no call to Wagon.setWagonExecutable() with an executable file before calling this constructor.
*/
@ -105,10 +113,8 @@ public class Wagon implements Runnable {
/**
* Export this feature definition in the "all.desc" format which can be read by wagon.
*
* @param out
* the destination of the data
* @param featuresToIgnore
* a set of Strings containing the names of features that wagon should ignore. Can be null.
* @throws IOException
* IOException
*/
private void createDescFile() throws IOException {
PrintWriter out = new PrintWriter(new FileOutputStream(descFile));

Просмотреть файл

@ -146,6 +146,9 @@ public class HNMFeatureFileWriter extends VoiceImportComponent {
/**
* Initialize this component
*
* @throws Exception
* Exception
*/
@Override
protected void initialiseComp() throws Exception {
@ -184,7 +187,9 @@ public class HNMFeatureFileWriter extends VoiceImportComponent {
* Create new directory if the directory doesn't exist
*
* @param dirName
* dirName
* @throws Exception
* Exception
*/
private void createDirectoryifNotExists(String dirName) throws Exception {
if (!(new File(dirName)).exists()) {
@ -200,7 +205,9 @@ public class HNMFeatureFileWriter extends VoiceImportComponent {
* Write the header of this feature file to the given DataOutput
*
* @param out
* out
* @throws IOException
* IOException
*/
protected void writeHeaderTo(DataOutput out) throws IOException {
new MaryHeader(MaryHeader.LISTENERFEATS).writeTo(out);
@ -208,6 +215,8 @@ public class HNMFeatureFileWriter extends VoiceImportComponent {
/**
* Return this voice import component name
*
* @return "HNMfeatureFileWriter"
*/
@Override
public String getName() {
@ -216,6 +225,8 @@ public class HNMFeatureFileWriter extends VoiceImportComponent {
/**
* Return the progress of this component
*
* @return this.progress
*/
@Override
public int getProgress() {
@ -224,6 +235,7 @@ public class HNMFeatureFileWriter extends VoiceImportComponent {
/**
* @param args
* args
*/
public static void main(String[] args) {
// TODO Auto-generated method stub

Просмотреть файл

@ -111,6 +111,9 @@ public class MLSAFeatureFileComputer extends VoiceImportComponent {
/**
* compute logf0, mgc, strength features
*
* @throws Exception
* Exception
*/
@Override
public boolean compute() throws Exception {
@ -248,12 +251,8 @@ public class MLSAFeatureFileComputer extends VoiceImportComponent {
/**
* Compute LF0 features for all RAW files using Snack and SPTK
*
* @throws IOException
* @throws Exception
* if can't run command
* @throws ExecutionException
* if commandline throws an error
* @throws ExecutionException
* if there is no output file or output file is empty
*/
private void computeLF0Features() throws Exception {
String bcCommand = "/usr/bin/bc";
@ -285,12 +284,8 @@ public class MLSAFeatureFileComputer extends VoiceImportComponent {
/**
* Compute MGC features for all RAW files using SPTK
*
* @throws IOException
* @throws Exception
* if can't run command
* @throws ExecutionException
* if commandline throws an error
* @throws ExecutionException
* if there is no output file or output file is empty
*/
private void computeMGCFeatures() throws Exception {
@ -321,12 +316,8 @@ public class MLSAFeatureFileComputer extends VoiceImportComponent {
/**
* Compute STRENGTH features for all RAW files using SPTK
*
* @throws IOException
* @throws Exception
* if can't run command
* @throws ExecutionException
* if commandline throws an error
* @throws ExecutionException
* if there is no output file or output file is empty
*/
private void computeSTRFeatures() throws Exception {
String bcCommand = "/usr/bin/bc";
@ -359,7 +350,9 @@ public class MLSAFeatureFileComputer extends VoiceImportComponent {
* Create new directory if the directory doesn't exist
*
* @param dirName
* dirName
* @throws Exception
* Exception
*/
private void createDirectoryifNotExists(String dirName) throws Exception {
if (!(new File(dirName)).exists()) {
@ -373,6 +366,8 @@ public class MLSAFeatureFileComputer extends VoiceImportComponent {
/**
* Return this voice import component name
*
* @return "MLSAFeatureFileComputer"
*/
@Override
public String getName() {
@ -381,6 +376,8 @@ public class MLSAFeatureFileComputer extends VoiceImportComponent {
/**
* Return the progress of this component
*
* @return this.progress
*/
@Override
public int getProgress() {
@ -389,6 +386,7 @@ public class MLSAFeatureFileComputer extends VoiceImportComponent {
/**
* @param args
* args
*/
public static void main(String[] args) {
// TODO Auto-generated method stub

Просмотреть файл

@ -181,7 +181,7 @@ public class MLSAFeatureFileWriter extends VoiceImportComponent {
/**
* Initialize this component
*
* @throws MaryConfigurationException
* @throws Exception
* if there is problem with basename list
*/
@Override
@ -249,6 +249,7 @@ public class MLSAFeatureFileWriter extends VoiceImportComponent {
/**
* @param args
* args
*/
public static void main(String[] args) {
// TODO Auto-generated method stub

Просмотреть файл

@ -122,7 +122,10 @@ public class SnackF0ContourExtractor extends VoiceImportComponent {
/**
* The standard compute() method of the VoiceImportComponent interface.
*
* @throws IOException
* IOException
* @throws InterruptedException
* InterruptedException
*/
public boolean compute() throws IOException, InterruptedException {
@ -195,6 +198,7 @@ public class SnackF0ContourExtractor extends VoiceImportComponent {
/**
* @param args
* args
*/
public static void main(String[] args) {
// TODO Auto-generated method stub

Просмотреть файл

@ -184,9 +184,13 @@ public class VocalizationF0PolyFeatureFileWriter extends VoiceImportComponent {
/**
* @param out
* out
* @throws IOException
* IOException
* @throws UnsupportedEncodingException
* UnsupportedEncodingException
* @throws FileNotFoundException
* FileNotFoundException
*/
protected void writeUnitFeaturesTo(DataOutput out) throws IOException, UnsupportedEncodingException, FileNotFoundException {
int numUnits = listenerUnits.getNumberOfUnits();
@ -456,7 +460,9 @@ public class VocalizationF0PolyFeatureFileWriter extends VoiceImportComponent {
* Write the header of this feature file to the given DataOutput
*
* @param out
* out
* @throws IOException
* IOException
*/
protected void writeHeaderTo(DataOutput out) throws IOException {
new MaryHeader(MaryHeader.LISTENERFEATS).writeTo(out);
@ -474,6 +480,9 @@ public class VocalizationF0PolyFeatureFileWriter extends VoiceImportComponent {
/**
* @param args
* args
* @throws Exception
* Exception
*/
public static void main(String[] args) throws Exception {
VocalizationF0PolyFeatureFileWriter acfeatsWriter = new VocalizationF0PolyFeatureFileWriter();

Просмотреть файл

@ -192,10 +192,11 @@ public class VocalizationF0PolynomialInspector extends VoiceImportComponent {
/**
* @param baseName
* baseName
* @throws IOException
* IOException
* @throws UnsupportedAudioFileException
* @throws UnsupportedEncodingException
* @throws FileNotFoundException
* UnsupportedAudioFileException
*/
protected void displaySentences(String baseName) throws IOException, UnsupportedAudioFileException {
/*
@ -439,6 +440,9 @@ public class VocalizationF0PolynomialInspector extends VoiceImportComponent {
/**
* @param args
* args
* @throws Exception
* Exception
*/
public static void main(String[] args) throws Exception {
VocalizationF0PolynomialInspector acfeatsWriter = new VocalizationF0PolynomialInspector();

Просмотреть файл

@ -250,7 +250,9 @@ public class VocalizationFeatureFileWriter extends VoiceImportComponent {
* Write the header of this feature file to the given DataOutput
*
* @param out
* out
* @throws IOException
* IOException
*/
protected void writeHeaderTo(DataOutput out) throws IOException {
new MaryHeader(MaryHeader.LISTENERFEATS).writeTo(out);
@ -268,6 +270,9 @@ public class VocalizationFeatureFileWriter extends VoiceImportComponent {
/**
* @param args
* args
* @throws Exception
* Exception
*/
public static void main(String[] args) throws Exception {
VocalizationFeatureFileWriter acfeatsWriter = new VocalizationFeatureFileWriter();

Просмотреть файл

@ -143,6 +143,9 @@ public class VocalizationIntonationWriter extends VoiceImportComponent {
* Reads and concatenates a list of waveforms into one single timeline file.
*
* @throws IOException
* IOException
* @throws MaryConfigurationException
* MaryConfigurationException
*/
@Override
public boolean compute() throws IOException, MaryConfigurationException {
@ -169,7 +172,9 @@ public class VocalizationIntonationWriter extends VoiceImportComponent {
/**
*
* @param out
* out
* @throws IOException
* IOException
*/
protected void writeUnitFeaturesTo(DataOutput out) throws IOException {
@ -218,9 +223,14 @@ public class VocalizationIntonationWriter extends VoiceImportComponent {
* get f0 contour of vocalization f0
*
* @param baseName
* baseName
* @param doInterpolate
* doInterpolate
* @return interpolateF0Array(f0Array) if doInterpolate, f0Array otherwise
* @throws UnsupportedAudioFileException
* UnsupportedAudioFileException
* @throws IOException
* IOException
*/
private double[] getVocalizationF0(String baseName, boolean doInterpolate) throws UnsupportedAudioFileException, IOException {
@ -271,6 +281,7 @@ public class VocalizationIntonationWriter extends VoiceImportComponent {
* to get polynomial coeffs of f0 contour
*
* @param f0Array
* f0Array
* @return null if f0Array == null, coeffs otherwise
*/
private double[] getPolynomialCoeffs(double[] f0Array) {
@ -290,6 +301,7 @@ public class VocalizationIntonationWriter extends VoiceImportComponent {
* to interpolate F0 contour values
*
* @param f0Array
* f0Array
* @return null if f0Array == null, f0AndInterpolate
*/
private double[] interpolateF0Array(double[] f0Array) {
@ -345,6 +357,7 @@ public class VocalizationIntonationWriter extends VoiceImportComponent {
* cut begin-end unvoiced segments
*
* @param array
* array
* @return null if array == null, newArray
*/
private double[] cutStartEndUnvoicedSegments(double[] array) {
@ -387,7 +400,9 @@ public class VocalizationIntonationWriter extends VoiceImportComponent {
* interpolate f0
*
* @param f0Array
* f0Array
* @param interpol
* interpol
* @return f0AndInterpolate
*/
private double[] combineF0andInterpolate(double[] f0Array, double[] interpol) {
@ -409,7 +424,9 @@ public class VocalizationIntonationWriter extends VoiceImportComponent {
* Write the header of this feature file to the given DataOutput
*
* @param out
* out
* @throws IOException
* IOException
*/
protected void writeHeaderTo(DataOutput out) throws IOException {
new MaryHeader(MaryHeader.LISTENERFEATS).writeTo(out);
@ -426,6 +443,7 @@ public class VocalizationIntonationWriter extends VoiceImportComponent {
/**
* @param args
* args
*/
public static void main(String[] args) {
// TODO Auto-generated method stub

Просмотреть файл

@ -92,6 +92,9 @@ public class VocalizationPitchmarker extends PraatPitchmarker {
/**
* The standard compute() method of the VoiceImportComponent interface.
*
* @throws IOException
* IOException
*/
public boolean compute() throws IOException {
@ -151,6 +154,7 @@ public class VocalizationPitchmarker extends PraatPitchmarker {
/**
* @param args
* args
*/
public static void main(String[] args) {
// TODO Auto-generated method stub

Просмотреть файл

@ -224,6 +224,7 @@ public class VocalizationTimelineMaker extends VoiceImportComponent {
/**
* @param args
* args
*/
public static void main(String[] args) {
// TODO Auto-generated method stub

Просмотреть файл

@ -230,6 +230,9 @@ public class VocalizationUnitfileWriter extends VoiceImportComponent {
/**
* @param labFile
* labFile
* @throws IOException
* IOException
* @return ulab
*/
private UnitLabel[] readLabFile(String labFile) throws IOException {
@ -282,8 +285,10 @@ public class VocalizationUnitfileWriter extends VoiceImportComponent {
* To get Label Unit DATA (time stamp, index, phone unit)
*
* @param line
* line
* @return ArrayList contains time stamp, index and phone unit
* @throws IOException
* IOException
*/
private ArrayList getLabelUnitData(String line) throws IOException {
if (line == null)

Просмотреть файл

@ -42,6 +42,8 @@ public class TreeConverter {
* This converts the WEKA-style ClassifierTree into a Mary CART tree. The FeatureDefinition and the Instances should conform
* with respect to the possible attributes and values.
*
* @param c45Tree
* c45Tree
* @param aFeatDef
* a FeatureDefinition storing possible attributes and values as they are used within MARY.
* @param inst
@ -76,6 +78,8 @@ public class TreeConverter {
* This converts the WEKA-style ClassifierTree into a Mary CART tree. The FeatureDefinition and the Instances should conform
* with respect to the possible attributes and values.
*
* @param c45Tree
* c45Tree
* @param aFeatDef
* a FeatureDefinition storing possible attributes and values as they are used within MARY.
* @param inst