Skip to content
GitLab
Projects
Groups
Snippets
Help
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
A
alta
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
5
Issues
5
List
Boards
Labels
Service Desk
Milestones
Merge Requests
1
Merge Requests
1
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Operations
Operations
Incidents
Environments
Packages & Registries
Packages & Registries
Container Registry
Analytics
Analytics
CI / CD
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
alta
alta
Commits
1f5384a2
Commit
1f5384a2
authored
Nov 13, 2013
by
Laurent Belcour
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Changing the main document entry to be better looking
parent
f2dee93e
Changes
4
Expand all
Hide whitespace changes
Inline
Side-by-side
Showing
4 changed files
with
1393 additions
and
166 deletions
+1393
-166
documents/alta_logo.svg
documents/alta_logo.svg
+144
-137
documents/doxygen.conf
documents/doxygen.conf
+9
-0
documents/doxygen.css
documents/doxygen.css
+1186
-0
documents/mainpage.dox
documents/mainpage.dox
+54
-29
No files found.
documents/alta_logo.svg
View file @
1f5384a2
This diff is collapsed.
Click to expand it.
documents/doxygen.conf
View file @
1f5384a2
PROJECT_NAME
=
ALTA
PROJECT_NUMBER
=
0
.
1
INPUT
= ../
sources
../
sources
/
scripts
.
OUTPUT_DIRECTORY
= ./
doxygen
RECURSIVE
=
YES
GENERATE_LATEX
=
NO
EXTRACT_ALL
=
NO
DISABLE_INDEX
=
YES
PROJECT_LOGO
=
alta_logo
.
svg
MULTILINE_CPP_IS_BRIEF
=
YES
HTML_STYLESHEET
=
doxygen
.
css
documents/doxygen.css
0 → 100644
View file @
1f5384a2
This diff is collapsed.
Click to expand it.
documents/mainpage.dox
View file @
1f5384a2
...
...
@@ -4,45 +4,70 @@
<h2>Description</h2>
ALTA is a software library to analyse, fit and understand BRDFs. It
provides a set of command line softwares to fit measured data to analytical
forms, new tools to understand models and data.
This package provide C++ code to analyze BRDF, fit measured data to
analytical formulation, etc. It is decomposed in three components:
<ul>
<li><em>\ref core</em>: a set of classes providing interfaces to BRDFs,
data type and fitting algorithms. All the code using this library should
rely on this part.</li>
<li><em>\ref plugins</em>: a set of plugins providing fitting algorithms
for rational BRDFs, non-linear BRDFs, etc.</li>
<li><em>\ref softs</em>: a set of tools to fit data, convert data,
export fitting to plots, etc.</li>
</ul>
Three types of plugins are availables:
<ul>
<li><em>\ref data</em> plugins allow to load BRDF measurements files.
</li>
<li><em>\ref function</em> plugins provide BRDF representations.</li>
<li><em>\ref fitter</em> plugins provide fitting algorithms.</li>
</ul>
<h2>Obtain sources</h2>
forms, tools to understand models and data.
<br /><br />
<h2>Download and install</h2>
<h3>Obtain sources</h3>
To access the sources of ALTA, you can clone the mercurial repository:
\verbatim
hg clone https://manao.inria.fr/mercurial/alta
\endverbatim
<h3>Build</h3>
You can build ALTA using either QMake or Scons. To start, we advise to use
Scons as it is lightweight and only requires Python to be installed (ALTA
uses Python for its high level scripting mechanism). To build using scons,
go to the root directory of ALTA and type:
\verbatim
scons -i
\endverbatim
This should obtain some of ALTA's dependencies (such as Eigen) and compile the
main package of the library (i.e. the core, the command line tools, and some
plugins).
To use QMake, or for a more detailed view of ALTA's building scripts and
dependencies, please refer to \ref install.
<br /><br />
<h2>How to use it</h2>
After compiling the different command line tools and associated plugins,
go to the sources directory and launch this command line (for Linux users only):
\verbatim
./build/data2brdf --input ../data/1d/Kirby.dat --output Kirby.brdf --fitter ./build/librational_fitter_eigen.so
\endverbatim
Tada ! You have produced your first BRDF fit.
The <i>data2brdf</i> is one of many \a commands available in ALTA. It
allows to perform a fitting procedure by converting a \ref data object into a
brdf object (also named \ref function).
To convert this brdf file (in ALTA \ref format), you will need another command:
\verbatim
./build/brdf2brdf --input Kirby.brdf --output Kirby.m --export matlab
\endverbatim
<i>brdf2brdf</i> converts an ALTA brdf file into another format such as
Matlab m file, C++ code, or BRDF Explorer shader. Note that this tool cannot
convert to another ALTA file (e.g. converting a Blinn lobe to a Beckmann
distribution).
<br /><br />
<h2>
Install and use ALTA
</h2>
<h2>
Contribute
</h2>
Documentation to \ref install
There are many ways in which you can extend ALTA. Please refer to
\ref contribute for more information.
Documentation to \ref contribute
The \ref plugins_manager class allows to load plugins and provide access
to requested elements. See the documentation of this class.
\defgroup core
\defgroup plugins
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment