added augmented descriptions

git-svn-id: https://svn.d4science.research-infrastructures.eu/gcube/trunk/data-analysis/EcologicalEngine@83054 82a268e6-3cf1-43bd-a215-b396298e98cf

src/main/java/org/gcube/dataanalysis/ecoengine/clustering/DBScan.java

@@ -439,7 +439,7 @@ public class DBScan implements Clusterer{
 
 	@Override
 	public String getDescription() {
-		return "Clustering with DBScan. A maximum of 4000 points is allowed.";
+		return "A clustering algorithm for real valued vectors that relies on the density-based spatial clustering of applications with noise (DBSCAN) algorithm. A maximum of 4000 points is allowed.";
 	}
 
 

src/main/java/org/gcube/dataanalysis/ecoengine/clustering/KMeans.java

@@ -142,7 +142,7 @@ public class KMeans extends DBScan{
 
 	@Override
 	public String getDescription() {
-		return "Clustering with KMeans. A Maximum of 4000 points is allowed.";
+		return "A clustering algorithm for real valued vectors that relies on the k-means algorithm, i.e. a method aiming to partition n observations into k clusters in which each observation belongs to the cluster with the nearest mean, serving as a prototype of the cluster.  A Maximum of 4000 points is allowed.";
 	}
 
 

src/main/java/org/gcube/dataanalysis/ecoengine/clustering/LOF.java

@@ -249,7 +249,7 @@ public class LOF extends DBScan {
 
 	@Override
 	public String getDescription() {
-		return "Local Outlier Factor (LOF). A Maximum of 4000 points is allowed.";
+		return "Local Outlier Factor (LOF). A clustering algorithm for real valued vectors that relies on Local Outlier Factor algorithm, i.e. an algorithm for finding anomalous data points by measuring the local deviation of a given data point with respect to its neighbours. A Maximum of 4000 points is allowed.";
 	}
 
 	ResourceFactory resourceManager;

src/main/java/org/gcube/dataanalysis/ecoengine/clustering/XMeansWrapper.java

@@ -144,7 +144,7 @@ public class XMeansWrapper extends DBScan {
 
 	@Override
 	public String getDescription() {
-		return "Clustering with XMeans Algorithm: X-Means is K-Means extended by an Improve-Structure part In this part of the algorithm the centers are attempted to be split in its region. A Maximum of 4000 points is allowed.";
+		return "A clustering algorithm for occurrence points that relies on the X-Means algorithm, i.e. an extended version of the K-Means algorithm improved by an Improve-Structure part. A Maximum of 4000 points is allowed.";
 	}
 
 	@Override

src/main/java/org/gcube/dataanalysis/ecoengine/evaluation/DiscrepancyAnalysis.java

@@ -258,6 +258,6 @@ public class DiscrepancyAnalysis extends DataAnalysis {
 
 		@Override
 	public String getDescription() {
-		return "Discrepancy Analysis bewteen two HSPEC distributions";
+		return "An evaluator algorithm that compares two tables containing real valued vectors. It drives the comparison by relying on a geographical distance threshold and a threshold for K-Statistic.";
 	}
 }

src/main/java/org/gcube/dataanalysis/ecoengine/evaluation/DistributionQualityAnalysis.java

@@ -333,7 +333,7 @@ public class DistributionQualityAnalysis extends DataAnalysis {
 
 	@Override
 	public String getDescription() {
-		return "Calculates the ROC, AUC and Accuracy of a model";
+		return "An evaluator algorithm that assesses the effectiveness of a distribution model by computing the Receiver Operating Characteristics (ROC), the Area Under Curve (AUC) and the Accuracy of a model";
 	}
 
 }

src/main/java/org/gcube/dataanalysis/ecoengine/evaluation/HabitatRepresentativeness.java

@@ -327,7 +327,7 @@ public class HabitatRepresentativeness extends DataAnalysis {
 
 	@Override
 	public String getDescription() {
-		return "Calculates the Habitat Representativeness Score for a set of Features";
+		return "An evaluator algorithm that calculates the Habitat Representativeness Score, i.e. an indicator of the assessment of whether a specific survey coverage or another environmental features dataset, contains data that are representative of all available habitat variable combinations in an area.";
 	}
 
 }

src/main/java/org/gcube/dataanalysis/ecoengine/models/FeedForwardNN.java

@@ -32,7 +32,7 @@ public class FeedForwardNN extends ModelAquamapsNN{
 
 	@Override
 	public String getDescription() {
-		return "A Neural Networks to be trained on features of Real values";
+		return "A method to train a generic Feed Forward Artifical Neural Network in order to simulate a function from the features space (R^n) to R. Uses the Back-propagation method. Produces a trained neural network in the form of a compiled file which can be used in the FEED FORWARD NEURAL NETWORK DISTRIBUTION algorithm.";
 	}
 	
 	

src/main/java/org/gcube/dataanalysis/ecoengine/models/ModelAquamapsNN.java

@@ -42,7 +42,7 @@ public class ModelAquamapsNN implements Model {
 
 	@Override
 	public String getDescription() {
-		return "Aquamaps Trained using Neural Networks";
+		return "The AquaMaps model trained using a Feed Forward Neural Network. This is a method to train a generic Feed Forward Artifical Neural Network to be used by the AquaMaps Neural Network algorithm. Produces a trained neural network in the form of a compiled file which can be used later.";
 	}
 
 	@Override

src/main/java/org/gcube/dataanalysis/ecoengine/models/ModelHSPEN.java

@@ -425,7 +425,7 @@ public class ModelHSPEN implements Model {
 
 	@Override
 	public String getDescription() {
-		return "Hspen Algorithm";
+		return "The AquMaps HSPEN algorithm. A modeling algorithm that generates a table containing species envelops (HSPEN), i.e. models capturing species tolerance with respect to environmental parameters, to be used by the AquaMaps approach.";
 	}
 
 	@Override

src/main/java/org/gcube/dataanalysis/ecoengine/spatialdistributions/AquamapsNN.java

@@ -28,7 +28,7 @@ public class AquamapsNN extends AquamapsNative{
 
 	@Override
 	public String getDescription() {
-		return "Aquamaps Native Algorithm calculated by neural network";
+		return "Aquamaps Native Algorithm calculated by a Neural Network. A distribution algorithm that relies on Neural Networks and AquaMaps data for native distributions to generate a table containing species distribution probabilities on half-degree cells.";
 	}
 
 	@Override

src/main/java/org/gcube/dataanalysis/ecoengine/spatialdistributions/AquamapsNNSuitable.java

@@ -33,7 +33,7 @@ public class AquamapsNNSuitable extends AquamapsSuitable{
 
 	@Override
 	public String getDescription() {
-		return "Aquamaps Algorithm for Suitable Environment calculated by neural network";
+		return "Aquamaps Algorithm for Suitable Environment calculated by Neural Network. A distribution algorithm that relies on Neural Networks and AquaMaps data for suitable distributions to generate a table containing species distribution probabilities on half-degree cells.";
 	}
 
 	@Override

src/main/java/org/gcube/dataanalysis/ecoengine/spatialdistributions/AquamapsNative.java

@@ -9,7 +9,7 @@ public class AquamapsNative extends AquamapsSuitable {
 
 	@Override
 	public String getDescription() {
-		return "Algorithm for Native Distribution by Aquamaps";
+		return "Algorithm for Native Distribution by AquaMaps. A distribution algorithm that generates a table containing  species distribution probabilities on half-degree cells according to the AquaMaps approach for Native (Actual) distributions.";
 	}
 	
 	@Override

src/main/java/org/gcube/dataanalysis/ecoengine/spatialdistributions/AquamapsNative2050.java

@@ -18,6 +18,6 @@ public class AquamapsNative2050 extends AquamapsNative {
 	
 	@Override
 	public String getDescription() {
-		return "Algorithm for Native 2050 Distribution by Aquamaps";
+		return "Algorithm for Native 2050 Distribution by AquaMaps. A distribution algorithm that generates a table containing  species distribution probabilities on half-degree cells according to the AquaMaps approach with native distribution estimated for 2050.";
 	}
 }

src/main/java/org/gcube/dataanalysis/ecoengine/spatialdistributions/AquamapsSuitable.java

@@ -244,7 +244,7 @@ public class AquamapsSuitable implements SpatialProbabilityDistributionTable{
 
 	@Override
 	public String getDescription() {
-		return "Algorithm for Suitable Distribution by Aquamaps";
+		return "Algorithm for Suitable Distribution by AquaMaps. A distribution algorithm that generates a table containing  species distribution probabilities on half-degree cells according to the AquaMaps approach for suitable (potential) distributions.";
 	}
 
 	@Override

src/main/java/org/gcube/dataanalysis/ecoengine/spatialdistributions/AquamapsSuitable2050.java

@@ -26,6 +26,6 @@ public class AquamapsSuitable2050 extends AquamapsSuitable {
 	
 	@Override
 	public String getDescription() {
-		return "Algorithm for Suitable 2050 Distribution by Aquamaps";
+		return "Algorithm for Suitable 2050 Distribution by AquaMaps. A distribution algorithm that generates a table containing  species distribution probabilities on half-degree cells according to the AquaMaps approach for suitable (potential) distributions for the 2050 scenario.";
 	}
 }

src/main/java/org/gcube/dataanalysis/ecoengine/spatialdistributions/FeedForwardNeuralNetworkDistribution.java

@@ -46,7 +46,7 @@ public class FeedForwardNeuralNetworkDistribution extends BayesianDistribution{
 
 	@Override
 	public String getDescription() {
-		return "A Bayesian method using a Feed Forward Neural Network simulating a function from the features space (R^n) to R";
+		return "A Bayesian method using a Feed Forward Neural Network to simulate a function from the features space (R^n) to R. A modeling algorithm that relies on Neural Networks to simulate a real valued function. It accepts as input a table containing the training dataset and some parameters affecting the algorithm behaviour such as the number of neurons, the learning threshold and the maximum number of iterations.";
 	}
 
 

src/main/java/org/gcube/dataanalysis/ecoengine/transducers/BioClimateHCAFTransducer.java

@@ -32,7 +32,7 @@ public class BioClimateHCAFTransducer extends BioClimateHSPECTransducer{
 
 	@Override
 	public String getDescription() {
-		return "Evaluates the climatic changes impact on the variation of the ocean features contained in Hcaf tables";
+		return "A transducer algorithm that generates an Half-degree Cells Authority File (HCAF) dataset for a certain time frame, with environmental parameters used by the AquaMaps approach. Evaluates the climatic changes impact on the variation of the ocean features contained in HCAF tables";
 	}
 
 	@Override

src/main/java/org/gcube/dataanalysis/ecoengine/transducers/BioClimateHSPECTransducer.java

@@ -65,7 +65,7 @@ public class BioClimateHSPECTransducer implements Transducerer{
 
 	@Override
 	public String getDescription() {
-		return "Evaluates the climatic changes impact on species presence";
+		return "A transducer algorithm that generates a table containing an estimate of species distributions per half-degree cell (HSPEC) in time. Evaluates the climatic changes impact on species presence.";
 	}
 
 	@Override

src/main/java/org/gcube/dataanalysis/ecoengine/transducers/BioClimateHSPENTransducer.java

@@ -29,7 +29,7 @@ public class BioClimateHSPENTransducer extends BioClimateHSPECTransducer{
 
 	@Override
 	public String getDescription() {
-		return "Evaluates the climatic changes impact on the variation of the salinity values in several ranges of a set of species envelopes";
+		return "A transducer algorithm that generates a table containing species envelops (HSPEN) in time, i.e. models capturing species tolerance with respect to environmental parameters, used by the AquaMaps approach. Evaluates the climatic changes impact on the variation of the salinity values in several ranges of a set of species envelopes";
 	}
 
 	@Override

src/main/java/org/gcube/dataanalysis/ecoengine/transducers/OccurrencePointsDuplicatesDeleter.java

@@ -62,7 +62,7 @@ public class OccurrencePointsDuplicatesDeleter extends OccurrencePointsMerger {
 
 	@Override
 	public String getDescription() {
-		return "An algorithm for deleting similar occurrences in a sets of occurrence points of species coming from the Species Discovery Facility of D4Science. Works with up to 100 000 points";
+		return "A transducer algorithm that produces a duplicate free table of species occurrence points where duplicates have been identified via user defined comparison thresholds. Works with up to 100 000 points";
 	}
 
 	@Override

src/main/java/org/gcube/dataanalysis/ecoengine/transducers/OccurrencePointsInSeaOnEarth.java

@@ -69,7 +69,7 @@ public class OccurrencePointsInSeaOnEarth extends OccurrencePointsMerger{
 	
 	@Override
 	public String getDescription() {
-		return "An algorithm for filtering only the points lying in the seas or on the earth. It acts on occurrence points of species coming from the Species Discovery Facility of D4Science";
+		return "A transducer algorithm that produces a table containing occurrence points by filtering them by type of area, i.e. by recognising whether they are marine or terrestrial.";
 	}
 	
 	@Override

src/main/java/org/gcube/dataanalysis/ecoengine/transducers/OccurrencePointsIntersector.java

@@ -13,7 +13,7 @@ public class OccurrencePointsIntersector extends OccurrencePointsMerger{
 	
 	@Override
 	public String getDescription() {
-		return "Between two Ocurrence Sets, keeps the elements of the Right Set that are similar to elements in the Left Set.";
+		return "A transducer algorithm that produces a table of species occurrence points that are contained in both the two starting tables where points equivalence is identified via user defined comparison thresholds. Between two ocurrence sets, it keeps the elements of the Right Set that are similar to elements in the Left Set.";
 	}
 	
 	@Override

src/main/java/org/gcube/dataanalysis/ecoengine/transducers/OccurrencePointsMerger.java

@@ -329,7 +329,7 @@ public class OccurrencePointsMerger implements Transducerer {
 
 	@Override
 	public String getDescription() {
-		return "Between two Ocurrence Sets, enrichs the Left Set with the elements of the Right Set that are not in the Left Set. Updates the elements of the Left Set with more recent elements in the Right Set. If one element in the Left Set corresponds to several recent elements in the Right Set, these will be all substituted to the element of the Left Set.";
+		return "A transducer algorithm that produces a duplicate-free table resulting from the union of two occurrence points tables where points equivalence is identified via user defined comparison thresholds. Between two Ocurrence Sets, enrichs the Left Set with the elements of the Right Set that are not in the Left Set. Updates the elements of the Left Set with more recent elements in the Right Set. If one element in the Left Set corresponds to several recent elements in the Right Set, these will be all substituted to the element of the Left Set.";
 	}
 
 	protected float probabilityStrings(String first, String second) {

src/main/java/org/gcube/dataanalysis/ecoengine/transducers/OccurrencePointsSubtraction.java

@@ -8,7 +8,7 @@ public class OccurrencePointsSubtraction extends OccurrencePointsMerger{
 	
 	@Override
 	public String getDescription() {
-		return "Between two Ocurrence Sets, keeps the elements of the Left Set that are not similar to any element in the Right Set";
+		return "A transducer algorithm that produces a table resulting from the difference between two occurrence points tables where points equivalence is identified via user defined comparison thresholds. Between two Ocurrence Sets, keeps the elements of the Left Set that are not similar to any element in the Right Set.";
 	}
 	
 	protected void manageHighProbability(float probability, OccurrenceRecord leftOcc, OccurrenceRecord rightOcc) {

src/main/java/org/gcube/dataanalysis/ecoengine/transducers/simplequeryexecutors/HspenFilter.java

@@ -56,7 +56,7 @@ public class HspenFilter extends QueryExecutor {
 	
 	@Override
 	public String getDescription() {
-		return "An algorithm producing a HSPEN table with only some selected species";
+		return "An algorithm producing a HSPEN table containing only the selected species";
 	}