Skip to content

pull request #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
21 changes: 21 additions & 0 deletions help/builder_help.sce
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
// Copyright (C) 2015 - IIT Bombay - FOSSEE
//
// Author: Shamika Mohanan
// Organization: FOSSEE, IIT Bombay
// Email: [email protected]
// This file must be used under the terms of the BSD.
// This source file is licensed as described in the file LICENSE, which
// you should have received as part of this distribution. The terms
// are also available at
// https://opensource.org/licenses/BSD-3-Clause

mode(-1)
lines(0)

toolbox_title = "FOSSEE_Image_Processing_Toolbox"

help_dir = get_absolute_file_path('builder_help.sce');

tbx_builder_help_lang("en_US", help_dir);

clear toolbox_title;
21 changes: 21 additions & 0 deletions help/builder_help.sce~
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
// Copyright (C) 2015 - IIT Bombay - FOSSEE
//
// Author: Harpreet Singh
// Organization: FOSSEE, IIT Bombay
// Email: [email protected]
// This file must be used under the terms of the BSD.
// This source file is licensed as described in the file LICENSE, which
// you should have received as part of this distribution. The terms
// are also available at
// https://opensource.org/licenses/BSD-3-Clause

mode(-1)
lines(0)

toolbox_title = "FOSSEE_Optimization_Toolbox"

help_dir = get_absolute_file_path('builder_help.sce');

tbx_builder_help_lang("en_US", help_dir);

clear toolbox_title;
17 changes: 17 additions & 0 deletions help/en_US/build_help.sce
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
// Copyright (C) 2015 - IIT Bombay - FOSSEE
//
// Author: Shamika Mohanan
// Organization: FOSSEE, IIT Bombay
// Email: [email protected]
// This file must be used under the terms of the BSD.
// This source file is licensed as described in the file LICENSE, which
// you should have received as part of this distribution. The terms
// are also available at
// https://opensource.org/licenses/BSD-3-Clause

help_lang_dir = get_absolute_file_path('build_help.sce');

tbx_build_help(TOOLBOX_TITLE, help_lang_dir);

clear help_lang_dir;

17 changes: 17 additions & 0 deletions help/en_US/build_help.sce~
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
// Copyright (C) 2015 - IIT Bombay - FOSSEE
//
// Author: Shamika Mohanan
// Organization: FOSSEE, IIT Bombay
// Email: [email protected]
// This file must be used under the terms of the BSD.
// This source file is licensed as described in the file LICENSE, which
// you should have received as part of this distribution. The terms
// are also available at
// https://opensource.org/licenses/BSD-3-Clause

help_lang_dir = get_absolute_file_path('build_help.sce');

tbx_build_help(TOOLBOX_TITLE, help_lang_dir);

clear help_lang_dir;

102 changes: 102 additions & 0 deletions help/en_US/colorChange.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
<?xml version="1.0" encoding="UTF-8"?>

<!--
*
* This help file was generated from colorChange.sci using help_from_sci().
*
-->

<refentry version="5.0-subset Scilab" xml:id="colorChange" xml:lang="en"
xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:svg="http://www.w3.org/2000/svg"
xmlns:ns3="http://www.w3.org/1999/xhtml"
xmlns:mml="http://www.w3.org/1998/Math/MathML"
xmlns:scilab="http://www.scilab.org"
xmlns:db="http://docbook.org/ns/docbook">

<refnamediv>
<refname>colorChange</refname>
<refpurpose>This function seamlessly mixes two differently colored versions of the input image.</refpurpose>
</refnamediv>


<refsynopsisdiv>
<title>Calling Sequence</title>
<synopsis>
src = imread("image-location-for-src");
mask = roiFreeHand(src); //we can also use other function to create the mask
outputImage = colorChange(src, mask, red_mul, green_mul, blue_mul )

</synopsis>
</refsynopsisdiv>

<refsection>
<title>Parameters</title>
<variablelist>
<varlistentry><term>outputImage:</term>
<listitem><para> resultant Output image</para></listitem></varlistentry>
<varlistentry><term>src:</term>
<listitem><para> Input source image</para></listitem></varlistentry>
<varlistentry><term>mask:</term>
<listitem><para> Input mask image with same size as that of source image.</para></listitem></varlistentry>
<varlistentry><term>red_mul:</term>
<listitem><para> R-channel multiply factor (float) (default value= 1.0f)</para></listitem></varlistentry>
<varlistentry><term>green_mul:</term>
<listitem><para> G-channel multiply factor.(float) (default value= 1.0f)</para></listitem></varlistentry>
<varlistentry><term>blue_mul:</term>
<listitem><para> B-channel multiply factor.(float) (default value= 1.0f)</para></listitem></varlistentry>
</variablelist>
</refsection>

<refsection>
<title>Description</title>
<para>
Given an original color image, two differently colored versions of this image can be mixed seamlessly.
</para>
<para>
</para>
</refsection>

<refsection>
<title>Examples</title>
<programlisting role="example"><![CDATA[
src = imread("/images/color2.jpeg");
mask = roiFreeHand(src); //creating a mask

outputImage1 = colorChange(src, mask) //using default value for all optional parameters
imshow(outputImage1);//view the output

outputImage2 = colorChange(src, mask,0.5 ) //specifying just the value of red_mul
imshow(outputImage2);//view the output

outputImage3 = colorChange(src, mask,0.5 , 1, 2.5 ) //specifying value of all optional parameter
imshow(outputImage3);//view the output

outputImage4 = colorChange(src, mask,0.5 , [] , 2.5 ) //skipping the second argument
imshow(outputImage4);//view the output

]]></programlisting>
</refsection>

<refsection>
<title>Examples</title>
<programlisting role="example"><![CDATA[
src = imread("../images/color2.jpeg");
[row col] = size(src)
mask = zeros(row,col) //creating a mask
mask(100:140,100:150) =255
imshow(mask); view the mask
outputImage = colorChange(src, mask,0.5 , 1, 2.5 ) //specifying value of all optional parameter
imshow(outputImage);//view the output

]]></programlisting>
</refsection>

<refsection>
<title>Authors</title>
<simplelist type="vert">
<member>Rohan Gurve</member>
</simplelist>
</refsection>
</refentry>
75 changes: 75 additions & 0 deletions help/en_US/convert.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
<?xml version="1.0" encoding="UTF-8"?>

<!--
*
* This help file was generated from convert.sci using help_from_sci().
*
-->

<refentry version="5.0-subset Scilab" xml:id="convert" xml:lang="en"
xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:svg="http://www.w3.org/2000/svg"
xmlns:ns3="http://www.w3.org/1999/xhtml"
xmlns:mml="http://www.w3.org/1998/Math/MathML"
xmlns:scilab="http://www.scilab.org"
xmlns:db="http://docbook.org/ns/docbook">

<refnamediv>
<refname>convert</refname>
<refpurpose>This function converts a matrix to another data type with optional scaling.</refpurpose>
</refnamediv>


<refsynopsisdiv>
<title>Calling Sequence</title>
<synopsis>
src = imread('location-of-src');
dst = convert(src,rtype, alpha,beta);

</synopsis>
</refsynopsisdiv>

<refsection>
<title>Parameters</title>
<variablelist>
<varlistentry><term>src :</term>
<listitem><para> the source matrix/image</para></listitem></varlistentry>
<varlistentry><term>alpha:</term>
<listitem><para> optional scale factor (default value is 1) (type- Double)</para></listitem></varlistentry>
<varlistentry><term>beta:</term>
<listitem><para> optional delta added to the scaled values (default value is 0) (type- Double)</para></listitem></varlistentry>
<varlistentry><term>rtype:</term>
<listitem><para> (type- string)desired output matrix type/depth.It supports the following types -&gt; 1) CV_8U, 2) CV_8S, 3) CV_16U ,4) CV_16S, 5) CV_32S, 6) CV_64F</para></listitem></varlistentry>
</variablelist>
</refsection>

<refsection>
<title>Description</title>
<para>
The method converts source pixel values to the target data type. saturate_cast&lt;&gt; is applied at the end to avoid possible overflows-
</para>
<para>
</para>
</refsection>

<refsection>
<title>Examples</title>
<programlisting role="example"><![CDATA[
src = imread('/images/color2.jpeg');
dst = convert(src,'CV_8U') //convert to 8 bit unsigned int using default values of alpha and beta
dst //viewing the content of dst

dst2 = convert(src,'CV_64F') //convert to 64 bit floating point using default values of alpha and beta
dst2 //viewing the content of dst2

]]></programlisting>
</refsection>

<refsection>
<title>Authors</title>
<simplelist type="vert">
<member>Rohan Gurve</member>
</simplelist>
</refsection>
</refentry>
70 changes: 70 additions & 0 deletions help/en_US/detailEnhance.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
<?xml version="1.0" encoding="UTF-8"?>

<!--
*
* This help file was generated from detailEnhance.sci using help_from_sci().
*
-->

<refentry version="5.0-subset Scilab" xml:id="detailEnhance" xml:lang="en"
xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:svg="http://www.w3.org/2000/svg"
xmlns:ns3="http://www.w3.org/1999/xhtml"
xmlns:mml="http://www.w3.org/1998/Math/MathML"
xmlns:scilab="http://www.scilab.org"
xmlns:db="http://docbook.org/ns/docbook">

<refnamediv>
<refname>detailEnhance</refname>
<refpurpose>This filter enhances the details of a the given image.</refpurpose>
</refnamediv>


<refsynopsisdiv>
<title>Calling Sequence</title>
<synopsis>
src = imread("image-location-for-src");
outputImage = detailEnhance(src,sigma_s,sigma_r)

</synopsis>
</refsynopsisdiv>

<refsection>
<title>Parameters</title>
<variablelist>
<varlistentry><term>outputImage:</term>
<listitem><para> resultant Output image</para></listitem></varlistentry>
<varlistentry><term>src:</term>
<listitem><para> Input 8-bit 3-channel image.</para></listitem></varlistentry>
<varlistentry><term>sigma_s:</term>
<listitem><para> Range between 0 to 200 (float) (default value is 10)</para></listitem></varlistentry>
<varlistentry><term>sigma_r:</term>
<listitem><para> Range between 0 to 1. (float) (default value is 0.15f)</para></listitem></varlistentry>
</variablelist>
</refsection>

<refsection>
<title>Examples</title>
<programlisting role="example"><![CDATA[

src = imread("/images/color2.jpeg");
outputImage1 = detailEnhance(src) //using the default values for optional parameter
imshow(outputImage1);//view the output

outputImage2 = detailEnhance(src,[],0.4) //providing value for second optional parameter
imshow(outputImage2);//view the output

outputImage3 = detailEnhance(src,121,0.4) // providing value all optional parameters
imshow(outputImage3);//view the output

]]></programlisting>
</refsection>

<refsection>
<title>Authors</title>
<simplelist type="vert">
<member>Rohan Gurve</member>
</simplelist>
</refsection>
</refentry>
Loading