added grid documents

Author: tremblap

doc/Grid.yaml

@@ -0,0 +1,40 @@
+# Part of the Fluid Corpus Manipulation Project (http://www.flucoma.org/)
+# Copyright 2017-2019 University of Huddersfield.
+# Licensed under the BSD-3 License.
+# See license.md file in the project root for full license information.
+# This project has received funding from the European Research Council (ERC)
+# under the European Union’s Horizon 2020 research and innovation programme
+# (grant agreement No 725899).
+---
+digest: Constrain a 2D DataSet into a Grid.
+sc-categries: Dimensionality Reduction, Data Processing
+sc-related: Classes/FluidMDS, Classes/FluidPCA, Classes/FluidUMAP, Classes/FluidDataSet
+see-also:
+description: |
+  Maps a set of 2D points in a :fluid-obj:`DataSet` to a rectangular grid using a variant of the jonker-volgenant algorithm(https://www.gwern.net/docs/statistics/decision/1987-jonker.pdf). It can be useful to obtain compact grid layouts from the output of dimensionality reduction algorithms such as :fluid-obj:`UMAP`, :fluid-obj:`PCA` or :fluid-obj:`MDS`. This is similar to projects like CloudToGrid (https://github.com/kylemcdonald/CloudToGrid/), RasterFairy (https://github.com/Quasimondo/RasterFairy) or IsoMatch (https://github.com/ohadf/isomatch).
+
+parameters:
+    oversample:
+      description: |
+        A factor to oversample the destination grid. The default is 1, so the grid has the same number of points as the input. Factors of 2 or more will allow a larger destination grid, which will respect the original shape a little more, but will also be sparser.
+    extent:
+      description: |
+        The size to which the selected axis will be constrained. The default is 0, which turns the constraints off.
+    axis:
+      description: |
+        The axis to which the extent constraint is applied. The default 0 is horizontal, and 1 is vertical.
+
+messages:
+  fitTransform:
+   description: |
+      Fit the model to a :fluid-obj:`DataSet` and write the new projected data to a destination FluidDataSet.
+   args:
+    - name: sourceDataSet
+      description: |
+        Source data, or the DataSet name
+    - name: destDataSet
+      description: |
+        Destination data, or the DataSet name
+    - name: action
+      description: |
+        Run when done

src/clients/Grid/CMakeLists.txt

@@ -0,0 +1,26 @@
+cmake_minimum_required(VERSION 3.3)
+
+include(${CMAKE_CURRENT_SOURCE_DIR}/../../../script/dump-pretarget.cmake)
+
+# set(CMAKE_CXX_STANDARD 11)
+# set(CMAKE_CXX_STANDARD_REQUIRED ON)
+add_executable(
+	${PROJECT_NAME}
+	${PROJECT_NAME}.cpp
+)
+# target_link_libraries(${PROJECT_NAME} FLUID_DECOMPOSITION)
+# target_include_directories(
+# 	${PROJECT_NAME}
+# 	PRIVATE
+# 	"${CMAKE_CURRENT_SOURCE_DIR}/../../include"
+# )
+#
+# target_include_directories(
+# 	${PROJECT_NAME}
+# 	SYSTEM PRIVATE
+# 	"${C74_MAX_INCLUDES}"
+# 	"${C74_MSP_INCLUDES}"
+# 	"${C74_JIT_INCLUDES}"
+# )
+
+include(${CMAKE_CURRENT_SOURCE_DIR}/../../../script/dump-posttarget.cmake)

src/clients/Grid/Grid.cpp

@@ -0,0 +1,9 @@
+#include <clients/nrt/GridClient.hpp>
+#include <FluidParameterDump.hpp>
+int main(int argc, char *argv[]) {
+  using namespace fluid::client;
+  if (!argc) std::cerr << "Please pass a folder to write to";
+  std::cout << "Write JSON to " << argv[1];
+  ParameterDump<NRTThreadedGridClient>::dump("Grid", argv[1]);
+  return 0;
+}