Commit 1f21c7bf authored by ctraizet's avatar ctraizet
Browse files

DOC: remove complex image parameters documentation in the Cookbook

No related merge requests found
Showing with 5 additions and 21 deletions
+5 -21
...@@ -25,7 +25,7 @@ import argparse ...@@ -25,7 +25,7 @@ import argparse
import re import re
import otbApplication import otbApplication
from otbApplication import ParameterType_Bool, ParameterType_Int, ParameterType_Radius, ParameterType_RAM, ParameterType_Float, ParameterType_String, ParameterType_StringList, ParameterType_InputFilename, ParameterType_OutputFilename, ParameterType_InputImage, ParameterType_ComplexInputImage, ParameterType_OutputImage, ParameterType_ComplexOutputImage, ParameterType_InputVectorData, ParameterType_OutputVectorData, ParameterType_Directory, ParameterType_Choice, ParameterType_InputImageList, ParameterType_InputVectorDataList, ParameterType_InputFilenameList, ParameterType_InputProcessXML, ParameterType_OutputProcessXML, ParameterType_ListView, ParameterType_Group from otbApplication import ParameterType_Bool, ParameterType_Int, ParameterType_Radius, ParameterType_RAM, ParameterType_Float, ParameterType_String, ParameterType_StringList, ParameterType_InputFilename, ParameterType_OutputFilename, ParameterType_InputImage, ParameterType_OutputImage, ParameterType_InputVectorData, ParameterType_OutputVectorData, ParameterType_Directory, ParameterType_Choice, ParameterType_InputImageList, ParameterType_InputVectorDataList, ParameterType_InputFilenameList, ParameterType_InputProcessXML, ParameterType_OutputProcessXML, ParameterType_ListView, ParameterType_Group
from otb_warnings import application_documentation_warnings from otb_warnings import application_documentation_warnings
...@@ -118,9 +118,6 @@ def GetApplicationExamplePythonSnippet(app,idx,expand = False, inputpath="",outp ...@@ -118,9 +118,6 @@ def GetApplicationExamplePythonSnippet(app,idx,expand = False, inputpath="",outp
if paramtype == ParameterType_InputImage : if paramtype == ParameterType_InputImage :
# app.SetParameterString(param,EncloseString(ExpandPath(value,inputpath,expand))) # app.SetParameterString(param,EncloseString(ExpandPath(value,inputpath,expand)))
output += "\t" + appname + ".SetParameterString("+EncloseString(param)+", "+EncloseString(ExpandPath(value,inputpath,expand))+")" output += "\t" + appname + ".SetParameterString("+EncloseString(param)+", "+EncloseString(ExpandPath(value,inputpath,expand))+")"
if paramtype == ParameterType_ComplexInputImage:
# app.SetParameterString(param,EncloseString(ExpandPath(value,inputpath,expand)))
output += "\t" + appname + ".SetParameterString("+EncloseString(param)+", "+EncloseString(ExpandPath(value,inputpath,expand))+")"
if paramtype == ParameterType_InputVectorData: if paramtype == ParameterType_InputVectorData:
# app.SetParameterString(param,EncloseString(ExpandPath(value,inputpath,expand))) # app.SetParameterString(param,EncloseString(ExpandPath(value,inputpath,expand)))
output += "\t" + appname + ".SetParameterString("+EncloseString(param)+", "+EncloseString(ExpandPath(value,inputpath,expand))+")" output += "\t" + appname + ".SetParameterString("+EncloseString(param)+", "+EncloseString(ExpandPath(value,inputpath,expand))+")"
...@@ -132,10 +129,6 @@ def GetApplicationExamplePythonSnippet(app,idx,expand = False, inputpath="",outp ...@@ -132,10 +129,6 @@ def GetApplicationExamplePythonSnippet(app,idx,expand = False, inputpath="",outp
output += "\t" + appname + ".SetParameterOutputImagePixelType("+EncloseString(param)+", "+str(foundcode)+")" output += "\t" + appname + ".SetParameterOutputImagePixelType("+EncloseString(param)+", "+str(foundcode)+")"
else: else:
output += "\t" + appname +".SetParameterString("+EncloseString(param)+", "+ EncloseString(ExpandPath(value,outputpath,expand)) + ")" output += "\t" + appname +".SetParameterString("+EncloseString(param)+", "+ EncloseString(ExpandPath(value,outputpath,expand)) + ")"
if paramtype == ParameterType_ComplexOutputImage :
# TODO: handle complex type properly
# app.SetParameterString(param,EncloseString(ExpandPath(value,outputpath,expand)))
output += "\t" + appname +".SetParameterString("+EncloseString(param)+", "+ EncloseString(ExpandPath(value,outputpath,expand)) + ")"
if paramtype == ParameterType_OutputVectorData: if paramtype == ParameterType_OutputVectorData:
# app.SetParameterString(param,EncloseString(ExpandPath(value,outputpath,expand))) # app.SetParameterString(param,EncloseString(ExpandPath(value,outputpath,expand)))
output += "\t" + appname +".SetParameterString("+EncloseString(param)+", "+ EncloseString(ExpandPath(value,outputpath,expand)) + ")" output += "\t" + appname +".SetParameterString("+EncloseString(param)+", "+ EncloseString(ExpandPath(value,outputpath,expand)) + ")"
...@@ -201,8 +194,8 @@ def rst_parameter_value(app, key): ...@@ -201,8 +194,8 @@ def rst_parameter_value(app, key):
values.update({ParameterType_String: "string"}) values.update({ParameterType_String: "string"})
values.update({ParameterType_StringList: "string1 string2..."}) values.update({ParameterType_StringList: "string1 string2..."})
values.update(dict.fromkeys([ParameterType_InputFilename, ParameterType_OutputFilename], "filename [dtype]")) values.update(dict.fromkeys([ParameterType_InputFilename, ParameterType_OutputFilename], "filename [dtype]"))
values.update(dict.fromkeys([ParameterType_InputImage, ParameterType_ComplexInputImage], "image")) values.update({ParameterType_InputImage: "image"})
values.update(dict.fromkeys([ParameterType_OutputImage, ParameterType_ComplexOutputImage], "image [dtype]")) values.update({ParameterType_OutputImage: "image [dtype]"})
values.update(dict.fromkeys([ParameterType_InputVectorData, ParameterType_OutputVectorData], "vectorfile")) values.update(dict.fromkeys([ParameterType_InputVectorData, ParameterType_OutputVectorData], "vectorfile"))
values.update({ParameterType_Directory: "directory"}) values.update({ParameterType_Directory: "directory"})
values.update({ParameterType_Choice: "choice"}) values.update({ParameterType_Choice: "choice"})
......
...@@ -101,9 +101,6 @@ Similar methods exist for binding a data object to an output parameter: ...@@ -101,9 +101,6 @@ Similar methods exist for binding a data object to an output parameter:
- ``SetParameterOutputImage(key,data)`` : link the image object to the - ``SetParameterOutputImage(key,data)`` : link the image object to the
given output parameter given output parameter
- ``SetParameterComplexOutputImage(key,data)`` : link the complex image
object to the given output parameter
- ``SetParameterOutputVectorData(key,data)`` : link the vector data - ``SetParameterOutputVectorData(key,data)`` : link the vector data
object to the given output parameter object to the given output parameter
...@@ -155,9 +152,6 @@ parameters: ...@@ -155,9 +152,6 @@ parameters:
- ``ParameterType_InputImageList`` : parameter storing a list of input - ``ParameterType_InputImageList`` : parameter storing a list of input
image. image.
- ``ParameterType_ComplexInputImage`` : parameter storing a complex
input image.
- ``ParameterType_InputVectorData`` : parameter storing input vector - ``ParameterType_InputVectorData`` : parameter storing input vector
data. data.
...@@ -172,9 +166,6 @@ parameters: ...@@ -172,9 +166,6 @@ parameters:
- ``ParameterType_OutputImage`` : parameter storing an output image. - ``ParameterType_OutputImage`` : parameter storing an output image.
- ``ParameterType_ComplexOutputImage`` : parameter storing a complex
output image.
- ``ParameterType_OutputVectorData`` : parameter storing an output - ``ParameterType_OutputVectorData`` : parameter storing an output
vector data. vector data.
...@@ -205,11 +196,11 @@ you can use a numeric parameter and change its role by calling ...@@ -205,11 +196,11 @@ you can use a numeric parameter and change its role by calling
``SetParameterRole(key,Role_Output)``. ``SetParameterRole(key,Role_Output)``.
The input types ``InputImage``, ``InputImageList``, The input types ``InputImage``, ``InputImageList``,
``ComplexInputImage``, ``InputVectorData`` and ``InputVectorDataList`` ``InputVectorData`` and ``InputVectorDataList``
store the name of the files to load, but they also encapsulate the store the name of the files to load, but they also encapsulate the
readers needed to produce the input data. readers needed to produce the input data.
The output types ``OutputImage``, ``ComplexOutputImage`` and The output types ``OutputImage`` and
``OutputVectorData`` store the name of the files to write, but they also ``OutputVectorData`` store the name of the files to write, but they also
encapsulate the corresponding writers. encapsulate the corresponding writers.
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment