summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMattias Andrée <maandree@operamail.com>2014-04-06 15:35:04 +0200
committerMattias Andrée <maandree@operamail.com>2014-04-06 15:35:04 +0200
commitddd9f98776f6c7c58fcf68d905dccd965fe642e9 (patch)
treeb6055831168eb240bc89dbd371ca64b9cc1a0186
parentremove path from process title (diff)
downloadblueshift-ddd9f98776f6c7c58fcf68d905dccd965fe642e9.tar.gz
blueshift-ddd9f98776f6c7c58fcf68d905dccd965fe642e9.tar.bz2
blueshift-ddd9f98776f6c7c58fcf68d905dccd965fe642e9.tar.xz
document tension
Signed-off-by: Mattias Andrée <maandree@operamail.com>
-rw-r--r--info/blueshift.texinfo22
-rw-r--r--src/interpolation.py2
2 files changed, 14 insertions, 10 deletions
diff --git a/info/blueshift.texinfo b/info/blueshift.texinfo
index 83b71be..e3a5ae5 100644
--- a/info/blueshift.texinfo
+++ b/info/blueshift.texinfo
@@ -1553,7 +1553,10 @@ to compensate for this, nearest-neighbour
interpolation is used. If you want to better
interpolation there are a few functions that
can be used to scale up the lookup table using
-interpolation.
+interpolation. These functions have three
+arguments: the red, the green and the blue
+colour curves to scale up. The functions
+return a tuple of these scaled up.
@table @code
@item linearly_interpolate_ramp
@@ -1562,16 +1565,17 @@ Scale up using linear interpolation.
@item cubicly_interpolate_ramp
Scale up using cubic Hermite interpolation.
+This function have one additional, optional,
+parameter: @code{tension}, those default value
+is 0. It is a floating point value that should
+be between 0 and 1.
+
@end table
-These functions thats three arguments:
-the red, the green and the blue colour
-curves to scale up. The functions return
-a tuple of these scaled up. All functions
-are will using linear interpolation if
-an interpolation segment is non-monotonic.
-This is done, automatically by the
-functions, by using the function
+All functions are will using linear
+interpolation if an interpolation segment
+is non-monotonic. This is done, automatically
+by the functions, by using the function
@code{eliminate_halos} that takes six
arguments and does not return anything.
@code{eliminate_halos}'s arguments are
diff --git a/src/interpolation.py b/src/interpolation.py
index 409bbdc..32dd2fa 100644
--- a/src/interpolation.py
+++ b/src/interpolation.py
@@ -47,7 +47,7 @@ def linearly_interpolate_ramp(r, g, b):
return (R, G, B)
-def cubicly_interpolate_ramp(r, g, b, tension = 0): # TODO demo and document tension parameter
+def cubicly_interpolate_ramp(r, g, b, tension = 0): # TODO demo tension parameter
'''
Interpolate ramps to the size of the output axes using cubic Hermite spline